From 9e270fa9420a877d6bf4fdc5c9390afb26ce76de Mon Sep 17 00:00:00 2001 From: Benjamin Clerc Date: Tue, 6 Jun 2023 18:27:47 +0200 Subject: [PATCH 1/2] Updated doc --- docs/classes/Fortinet-FortiOSAPI-Config.html | 212 +- .../Fortinet-FortiOSAPI-Configuration.html | 14 +- .../Fortinet-FortiOSAPI-FortiOSAPI.html | 14 +- .../Fortinet-FortiOSAPI-FortiOSAPICmdb.html | 259152 --------------- .../Fortinet-FortiOSAPI-FortiOSAPILog.html | 5271 - ...Fortinet-FortiOSAPI-FortiOSAPIMonitor.html | 26648 -- docs/classes/Fortinet-FortiOSAPI-Log.html | 14 +- docs/classes/Fortinet-FortiOSAPI-Monitor.html | 14 +- ...rc-fortinet-fortiosapi-fortiosapicmdb.html | 123 - ...src-fortinet-fortiosapi-fortiosapilog.html | 123 - ...fortinet-fortiosapi-fortiosapimonitor.html | 123 - docs/js/searchIndex.js | 155 +- docs/namespaces/fortinet-fortiosapi.html | 4 +- docs/packages/Default.html | 4 +- 14 files changed, 309 insertions(+), 291562 deletions(-) delete mode 100644 docs/classes/Fortinet-FortiOSAPI-FortiOSAPICmdb.html delete mode 100644 docs/classes/Fortinet-FortiOSAPI-FortiOSAPILog.html delete mode 100644 docs/classes/Fortinet-FortiOSAPI-FortiOSAPIMonitor.html delete mode 100644 docs/files/src-fortinet-fortiosapi-fortiosapicmdb.html delete mode 100644 docs/files/src-fortinet-fortiosapi-fortiosapilog.html delete mode 100644 docs/files/src-fortinet-fortiosapi-fortiosapimonitor.html diff --git a/docs/classes/Fortinet-FortiOSAPI-Config.html b/docs/classes/Fortinet-FortiOSAPI-Config.html index 8dfdf52..a03447d 100644 --- a/docs/classes/Fortinet-FortiOSAPI-Config.html +++ b/docs/classes/Fortinet-FortiOSAPI-Config.html @@ -89,7 +89,7 @@

FortiOSAPI configuration.

@@ -142,6 +142,13 @@

 : string +
+ +
+ $proxy + +  : string +
@@ -191,6 +198,13 @@

 : string

+
+ +
+ $proxy + +  : string +
@@ -249,6 +263,13 @@

Getter for API autorized user's password.
+
+ getProxy() + +  : string +
+
Getter for curl proxy string.
+
getSSLVerifyHost() @@ -284,6 +305,13 @@

Setter for API version to use.
+
+ setProxy() + +  : Config +
+
Setter for proxy connect url.
+
setSSLVerifyHost() @@ -412,6 +440,38 @@

+ +
+

+ $proxy + + + +

+ + + + + public + string + $proxy + + +

proxy url to use.

+
+ + +
+
+

+ $proxy + + + +

+ + + + + private + string + $proxy + = "" + + + +
@@ -677,7 +767,7 @@

@@ -707,7 +797,7 @@

@@ -737,7 +827,7 @@

@@ -771,7 +861,7 @@

Constructor takes care of checking and registering information.

@@ -836,7 +926,7 @@

Getter for API version to use.

@@ -871,7 +961,7 @@

Getter for firewall's FQDN.

@@ -906,7 +996,7 @@

Getter for API autorized user's password.

@@ -927,6 +1017,41 @@

Return values
+
+
+

+ getProxy() + +

+ + +

Getter for curl proxy string.

+ + + public + getProxy() : string + +
+ + + + +
Return values
+ string + — +

proxy connect url

+
+ +

Getter for curl's option to verify SSL peer.

@@ -976,7 +1101,7 @@

Getter for curl's option to verify SSL peer.

@@ -1011,7 +1136,7 @@

Getter for curl's timeout in ms.

@@ -1046,7 +1171,7 @@

Getter for API autorized user.

@@ -1081,7 +1206,7 @@

Setter for API version to use.

@@ -1114,6 +1239,53 @@

Return values
+
+
+

+ setProxy() + +

+ + +

Setter for proxy connect url.

+ + + public + setProxy(string $url) : Config + +
+ +
Parameters
+
+
+ $url + : string +
+
+

Curl's proxy connect url.

+
+ +
+
+ + + +
Return values
+ Config + — +

Config object to be passed on a new instance of FortiOS APIs classes.

+
+ +

Setter for curl's option to verify SSL peer.

@@ -1175,7 +1347,7 @@

Setter for curl's option to verify SSL peer.

@@ -1222,7 +1394,7 @@

Setter for curl's timeout in ms.

diff --git a/docs/classes/Fortinet-FortiOSAPI-Configuration.html b/docs/classes/Fortinet-FortiOSAPI-Configuration.html index 101895c..6770de0 100644 --- a/docs/classes/Fortinet-FortiOSAPI-Configuration.html +++ b/docs/classes/Fortinet-FortiOSAPI-Configuration.html @@ -13844,7 +13844,7 @@

Abort a transaction (rollback operations).

@@ -45791,7 +45791,7 @@

Commit a transaction (apply operations).

@@ -203094,7 +203094,7 @@

List all transactions.

@@ -203140,7 +203140,7 @@

Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

@@ -259021,7 +259021,7 @@

Function used to build a query with params but following fortigate satndards.

@@ -259068,7 +259068,7 @@

Login in the firewall.

@@ -259103,7 +259103,7 @@

Logout from the firewall.

diff --git a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPI.html b/docs/classes/Fortinet-FortiOSAPI-FortiOSAPI.html index 6f26bdf..a5dae4a 100644 --- a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPI.html +++ b/docs/classes/Fortinet-FortiOSAPI-FortiOSAPI.html @@ -534,7 +534,7 @@

Abort a transaction (rollback operations).

@@ -581,7 +581,7 @@

Commit a transaction (apply operations).

@@ -628,7 +628,7 @@

List all transactions.

@@ -674,7 +674,7 @@

Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

@@ -820,7 +820,7 @@

Function used to build a query with params but following fortigate satndards.

@@ -867,7 +867,7 @@

Login in the firewall.

@@ -902,7 +902,7 @@

Logout from the firewall.

diff --git a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPICmdb.html b/docs/classes/Fortinet-FortiOSAPI-FortiOSAPICmdb.html deleted file mode 100644 index c5da8b1..0000000 --- a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPICmdb.html +++ /dev/null @@ -1,259152 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
-

Documentation

- - -
- -
- - -
- -
-
- - - - -
- - -
-

- FortiOSAPICmdb - - - extends FortiOSAPI - - - - -

- - - -

FortiOS API Cmdb

- -
- - -
- Tags - -
-
-
- link -
-
-

Fortinet developer ressource center.

- - -
-
- - - - - - -

- Table of Contents - -

- -
-
- $config - -  : Config -
-
- -
- $session_key - -  : string -
-
- -
- $transaction - -  : int|null -
-
- -
- $config - -  : Config -
-
- -
- $session_key - -  : string -
-
- -
- $transaction - -  : mixed -
-
- -
- __construct() - -  : mixed -
-
Constructor takes care of checking and registering firewall's data and login to the API
- -
- __destruct() - -  : mixed -
-
Destructor takes care of logout.
- -
- abortTransaction() - -  : bool -
-
Abort a transaction (rollback operations).
- -
- addAntivirusProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addApplicationCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addApplicationGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addApplicationList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addApplicationName() - -  : stdClass -
-
Create object(s) in this table.
- -
- addApplicationRuleSettings() - -  : stdClass -
-
Create object(s) in this table.
- -
- addAuthenticationRule() - -  : stdClass -
-
Create object(s) in this table.
- -
- addAuthenticationScheme() - -  : stdClass -
-
Create object(s) in this table.
- -
- addCertificateCa() - -  : stdClass -
-
Create object(s) in this table.
- -
- addCertificateCrl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addCertificateLocal() - -  : stdClass -
-
Create object(s) in this table.
- -
- addCertificateRemote() - -  : stdClass -
-
Create object(s) in this table.
- -
- addCredentialStoreDomainController() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDlpFilepattern() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDlpFpDocSource() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDlpSensitivity() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDlpSensor() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDnsfilterDomainFilter() - -  : stdClass -
-
Create object(s) in this table.
- -
- addDnsfilterProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterBwl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterBword() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterDnsbl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterIptrust() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterMheader() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEmailfilterProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addEndpointControlFctems() - -  : stdClass -
-
Create object(s) in this table.
- -
- addExtenderControllerDataplan() - -  : stdClass -
-
Create object(s) in this table.
- -
- addExtenderControllerExtender() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFileFilterProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAcl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAcl6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAddress() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAddress6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAddress6Template() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAddrgrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallAddrgrp6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallCentralSnatMap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallCity() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallCountry() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallDecryptedTrafficMirror() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallDnstranslation() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallDosPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallDosPolicy6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallIdentityBasedRoute() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInterfacePolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInterfacePolicy6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetService() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceAddition() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceBotnet() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceCustomGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceDefinition() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceExtension() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceIpblReason() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceIpblVendor() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceName() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceOwner() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceReputation() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallInternetServiceSld() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallIpmacbindingTable() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallIppool() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallIppool6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallIpTranslation() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallLdbMonitor() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallLocalInPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallLocalInPolicy6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallMulticastAddress() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallMulticastAddress6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallMulticastPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallMulticastPolicy6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallPolicy46() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallPolicy64() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallProfileGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallProfileProtocolOptions() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallProxyAddress() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallProxyAddrgrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallProxyPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallRegion() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallScheduleGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallScheduleOnetime() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallScheduleRecurring() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSecurityPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallServiceCategory() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallServiceCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallServiceGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallShaperPerIpShaper() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallShaperTrafficShaper() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallShapingPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallShapingProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSniffer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSshHostKey() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSshLocalCa() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSshLocalKey() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSslServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallSslSshProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallTrafficClass() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallTtlPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVendorMac() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVip() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVip46() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVip6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVip64() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVipgrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVipgrp46() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVipgrp6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallVipgrp64() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallWildcardfqdnCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addFirewallWildcardfqdnGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIcapProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIcapServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsDecoder() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsRule() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsRuleSettings() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsSensor() - -  : stdClass -
-
Create object(s) in this table.
- -
- addIpsViewMap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addLogCustomField() - -  : stdClass -
-
Create object(s) in this table.
- -
- addReportChart() - -  : stdClass -
-
Create object(s) in this table.
- -
- addReportDataset() - -  : stdClass -
-
Create object(s) in this table.
- -
- addReportLayout() - -  : stdClass -
-
Create object(s) in this table.
- -
- addReportStyle() - -  : stdClass -
-
Create object(s) in this table.
- -
- addReportTheme() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterAccessList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterAccessList6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterAspathList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterAuthPath() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterCommunityList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterKeyChain() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterMulticastFlow() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterPolicy6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterPrefixList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterPrefixList6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterRouteMap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterStatic() - -  : stdClass -
-
Create object(s) in this table.
- -
- addRouterStatic6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSshFilterProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchcontrollerInitialconfigTemplate() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerLldpProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerLocation() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerMacPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerManagedSwitch() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerNacDevice() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerNacSettings() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerPortPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchcontrollerSecuritypolicy8021x() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerSnmpCommunity() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerStpInstance() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerSwitchGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSwitchControllerVlanPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystem3gmodemCustom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAccprofile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAdmin() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemApiUser() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemArpTable() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAutomationAction() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAutomationDestination() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAutomationStitch() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAutomationTrigger() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemAutoScript() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemClusterSync() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemCustomLanguage() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDdns() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDhcp6Server() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDhcpServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDnsDatabase() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDnsServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemDscpBasedPriority() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemExternalResource() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemGeneve() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemGeoipCountry() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemGeoipOverride() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemGreTunnel() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemInterface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpipTunnel() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpsecAggregate() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpsUrlfilterDns() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpsUrlfilterDns6() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpv6NeighborCache() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemIpv6Tunnel() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemLinkMonitor() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemLldpNetworkPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemMacAddressTable() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemMobileTunnel() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemObjectTagging() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemPhysicalSwitch() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemPppoeInterface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemProxyArp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgAdmin() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgAlertmail() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgAuth() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgFortiguardWf() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgFtp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgHttp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgIcap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgImage() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgMail() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgNacQuar() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgSpam() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgSslvpn() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgTrafficQuota() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgUtm() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemReplacemsgWebproxy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSdnConnector() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSessionHelper() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSitTunnel() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSmsServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSnmpCommunity() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSnmpUser() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSpeedTestServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSsoAdmin() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemStorage() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemSwitchInterface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemTosBasedPriority() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVdom() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVdomException() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVdomLink() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVdomProperty() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVdomRadiusServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVirtualSwitch() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVirtualWirePair() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemVxlan() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemWccp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addSystemZone() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserAdgrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserDomainController() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserExchange() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserFortitoken() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserFsso() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserFssoPolling() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserKrbKeytab() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserLdap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserLocal() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserNacPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserPasswordPolicy() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserPeer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserPeergrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserPop3() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserRadius() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserSaml() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserSecurityExemptList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addUserTacacs() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVoipProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnCertificateCa() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnCertificateCrl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnCertificateLocal() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnCertificateOcspServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnCertificateRemote() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecConcentrator() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecForticlient() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecManualkey() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecManualkeyInterface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecPhase1() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecPhase1Interface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecPhase2() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnIpsecPhase2Interface() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnSslWebHostCheckSoftware() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnSslWebPortal() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnSslWebRealm() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnSslWebUserBookmark() - -  : stdClass -
-
Create object(s) in this table.
- -
- addVpnSslWebUserGroupBookmark() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWafMainClass() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWafProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWafSignature() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWanoptAuthGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWanoptContentDeliveryNetworkRule() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWanoptPeer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWanoptProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterContent() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterContentHeader() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterFtgdLocalCat() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterFtgdLocalRating() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterOverride() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterSearchEngine() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebfilterUrlfilter() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyDebugUrl() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyForwardServer() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyForwardServerGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyUrlMatch() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWebProxyWisp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerAccessControlList() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerAddress() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerAddrgrp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerApcfgProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerApStatus() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerArrpProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerBleProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerBonjourProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20Anqp3gppCellular() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20AnqpIpAddressType() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20AnqpNaiRealm() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20AnqpNetworkAuthType() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20AnqpRoamingConsortium() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20AnqpVenueName() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20H2qpConnCapability() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20H2qpOperatorName() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20H2qpOsuProvider() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20H2qpWanMetric() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20HsProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20Icon() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelesscontrollerHotspot20QosMap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerMpskProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerQosProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerRegion() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerUtmProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerVap() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerVapGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerWagProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerWidsProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerWtp() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerWtpGroup() - -  : stdClass -
-
Create object(s) in this table.
- -
- addWirelessControllerWtpProfile() - -  : stdClass -
-
Create object(s) in this table.
- -
- commitTransaction() - -  : bool -
-
Commit a transaction (apply operations).
- -
- deleteAntivirusProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteApplicationCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteApplicationGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteApplicationList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteApplicationName() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteApplicationRuleSettings() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteAuthenticationRule() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteAuthenticationScheme() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteCertificateCa() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteCertificateCrl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteCertificateLocal() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteCertificateRemote() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteCredentialStoreDomainController() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDlpFilepattern() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDlpFpDocSource() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDlpSensitivity() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDlpSensor() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDnsfilterDomainFilter() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteDnsfilterProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterBwl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterBword() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterDnsbl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterIptrust() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterMheader() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEmailfilterProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteEndpointControlFctems() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteExtenderControllerDataplan() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteExtenderControllerExtender() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFileFilterProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAcl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAcl6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAddress() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAddress6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAddress6Template() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAddrgrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallAddrgrp6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallCentralSnatMap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallCity() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallCountry() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallDecryptedTrafficMirror() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallDnstranslation() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallDosPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallDosPolicy6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallIdentityBasedRoute() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInterfacePolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInterfacePolicy6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetService() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceAddition() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceBotnet() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceCustomGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceDefinition() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceExtension() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceIpblReason() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceIpblVendor() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceName() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceOwner() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceReputation() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallInternetServiceSld() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallIpmacbindingTable() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallIppool() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallIppool6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallIpTranslation() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallLdbMonitor() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallLocalInPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallLocalInPolicy6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallMulticastAddress() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallMulticastAddress6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallMulticastPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallMulticastPolicy6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallPolicy46() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallPolicy64() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallProfileGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallProfileProtocolOptions() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallProxyAddress() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallProxyAddrgrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallProxyPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallRegion() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallScheduleGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallScheduleOnetime() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallScheduleRecurring() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSecurityPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallServiceCategory() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallServiceCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallServiceGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallShaperPerIpShaper() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallShaperTrafficShaper() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallShapingPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallShapingProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSniffer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSshHostKey() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSshLocalCa() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSshLocalKey() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSslServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallSslSshProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallTrafficClass() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallTtlPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVendorMac() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVip() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVip46() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVip6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVip64() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVipgrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVipgrp46() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVipgrp6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallVipgrp64() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallWildcardfqdnCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteFirewallWildcardfqdnGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIcapProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIcapServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsDecoder() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsRule() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsRuleSettings() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsSensor() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteIpsViewMap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteLogCustomField() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteReportChart() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteReportDataset() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteReportLayout() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteReportStyle() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteReportTheme() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterAccessList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterAccessList6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterAspathList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterAuthPath() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterCommunityList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterKeyChain() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterMulticastFlow() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterPolicy6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterPrefixList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterPrefixList6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterRouteMap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterStatic() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteRouterStatic6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSshFilterProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchcontrollerInitialconfigTemplate() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerLldpProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerLocation() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerMacPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerManagedSwitch() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerNacDevice() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerNacSettings() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerPortPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchcontrollerSecuritypolicy8021x() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerSnmpCommunity() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerStpInstance() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerSwitchGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSwitchControllerVlanPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystem3gmodemCustom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAccprofile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAdmin() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemApiUser() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemArpTable() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAutomationAction() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAutomationDestination() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAutomationStitch() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAutomationTrigger() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemAutoScript() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemClusterSync() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemCustomLanguage() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDdns() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDhcp6Server() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDhcpServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDnsDatabase() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDnsServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemDscpBasedPriority() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemExternalResource() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemGeneve() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemGeoipCountry() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemGeoipOverride() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemGreTunnel() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemInterface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpipTunnel() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpsecAggregate() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpsUrlfilterDns() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpsUrlfilterDns6() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpv6NeighborCache() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemIpv6Tunnel() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemLinkMonitor() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemLldpNetworkPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemMacAddressTable() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemMobileTunnel() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemObjectTagging() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemPhysicalSwitch() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemPppoeInterface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemProxyArp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgAdmin() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgAlertmail() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgAuth() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgFortiguardWf() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgFtp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgHttp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgIcap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgImage() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgMail() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgNacQuar() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgSpam() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgSslvpn() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgTrafficQuota() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgUtm() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemReplacemsgWebproxy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSdnConnector() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSessionHelper() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSitTunnel() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSmsServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSnmpCommunity() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSnmpUser() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSpeedTestServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSsoAdmin() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemStorage() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemSwitchInterface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemTosBasedPriority() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVdom() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVdomException() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVdomLink() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVdomProperty() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVdomRadiusServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVirtualSwitch() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVirtualWirePair() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemVxlan() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemWccp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteSystemZone() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserAdgrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserDomainController() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserExchange() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserFortitoken() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserFsso() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserFssoPolling() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserKrbKeytab() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserLdap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserLocal() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserNacPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserPasswordPolicy() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserPeer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserPeergrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserPop3() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserRadius() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserSaml() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserSecurityExemptList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteUserTacacs() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVoipProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnCertificateCa() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnCertificateCrl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnCertificateLocal() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnCertificateOcspServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnCertificateRemote() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecConcentrator() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecForticlient() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecManualkey() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecManualkeyInterface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecPhase1() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecPhase1Interface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecPhase2() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnIpsecPhase2Interface() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnSslWebHostCheckSoftware() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnSslWebPortal() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnSslWebRealm() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnSslWebUserBookmark() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteVpnSslWebUserGroupBookmark() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWafMainClass() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWafProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWafSignature() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWanoptAuthGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWanoptContentDeliveryNetworkRule() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWanoptPeer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWanoptProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterContent() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterContentHeader() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterFtgdLocalCat() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterFtgdLocalRating() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterOverride() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterSearchEngine() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebfilterUrlfilter() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyDebugUrl() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyForwardServer() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyForwardServerGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyUrlMatch() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWebProxyWisp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerAccessControlList() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerAddress() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerAddrgrp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerApcfgProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerApStatus() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerArrpProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerBleProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerBonjourProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20Anqp3gppCellular() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20AnqpIpAddressType() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20AnqpNaiRealm() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20AnqpNetworkAuthType() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20AnqpRoamingConsortium() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20AnqpVenueName() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20H2qpConnCapability() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20H2qpOperatorName() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20H2qpOsuProvider() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20H2qpWanMetric() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20HsProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20Icon() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelesscontrollerHotspot20QosMap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerMpskProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerQosProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerRegion() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerUtmProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerVap() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerVapGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerWagProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerWidsProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerWtp() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerWtpGroup() - -  : stdClass -
-
Delete this specific resource.
- -
- deleteWirelessControllerWtpProfile() - -  : stdClass -
-
Delete this specific resource.
- -
- getAllAlertemailSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAntivirusHeuristic() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAntivirusProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAntivirusQuarantine() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAntivirusSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllApplicationCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllApplicationGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllApplicationList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllApplicationName() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllApplicationRuleSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAuthenticationRule() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAuthenticationScheme() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllAuthenticationSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllCertificateCa() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllCertificateCrl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllCertificateLocal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllCertificateRemote() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllCredentialStoreDomainController() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDlpFilepattern() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDlpFpDocSource() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDlpSensitivity() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDlpSensor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDlpSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDnsfilterDomainFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllDnsfilterProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterBwl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterBword() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterDnsbl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterFortishield() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterIptrust() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterMheader() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterOptions() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEmailfilterProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllEndpointControlFctems() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllExtenderControllerDataplan() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllExtenderControllerExtender() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFileFilterProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAcl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAcl6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAddress() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAddress6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAddress6Template() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAddrgrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAddrgrp6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallAuthPortal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallCentralSnatMap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallCity() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallCountry() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallDecryptedTrafficMirror() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallDnstranslation() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallDosPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallDosPolicy6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIdentityBasedRoute() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInterfacePolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInterfacePolicy6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetService() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceAddition() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceAppend() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceBotnet() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceCustomGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceDefinition() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceExtension() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceIpblReason() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceIpblVendor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceName() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceOwner() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceReputation() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallInternetServiceSld() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIpmacbindingSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIpmacbindingTable() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIppool() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIppool6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallIpTranslation() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallLdbMonitor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallLocalInPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallLocalInPolicy6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallMulticastAddress() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallMulticastAddress6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallMulticastPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallMulticastPolicy6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallPolicy46() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallPolicy64() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallProfileGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallProfileProtocolOptions() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallProxyAddress() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallProxyAddrgrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallProxyPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallRegion() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallScheduleGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallScheduleOnetime() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallScheduleRecurring() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSecurityPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallServiceCategory() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallServiceCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallServiceGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallShaperPerIpShaper() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallShaperTrafficShaper() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallShapingPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallShapingProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSniffer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSshHostKey() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSshLocalCa() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSshLocalKey() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSshSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSslServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSslSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallSslSshProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallTrafficClass() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallTtlPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVendorMac() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVendorMacSummary() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVip() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVip46() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVip6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVip64() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVipgrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVipgrp46() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVipgrp6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallVipgrp64() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallWildcardfqdnCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFirewallWildcardfqdnGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllFtpProxyExplicit() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIcapProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIcapServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsDecoder() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsGlobal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsRule() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsRuleSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsSensor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllIpsViewMap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogCustomField() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogDiskFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogDiskSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogEventfilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer2Filter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer2OverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer2OverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer2Setting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer3Filter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer3OverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer3OverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzer3Setting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzercloudFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzercloudOverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzercloudOverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzercloudSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzerFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzerOverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzerOverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortianalyzerSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortiguardFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortiguardOverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortiguardOverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogFortiguardSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogGuiDisplay() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogMemoryFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogMemoryGlobalSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogMemorySetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogNulldeviceFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogNulldeviceSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd2Filter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd2OverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd2OverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd2Setting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd3Filter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd3OverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd3OverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd3Setting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd4Filter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd4OverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd4OverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogd4Setting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogdFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogdOverrideFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogdOverrideSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogSyslogdSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogThreatWeight() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogWebtrendsFilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllLogWebtrendsSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportChart() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportDataset() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportLayout() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportStyle() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllReportTheme() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterAccessList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterAccessList6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterAspathList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterAuthPath() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterBfd() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterBfd6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterBgp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterCommunityList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterIsis() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterKeyChain() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterMulticast() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterMulticast6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterMulticastFlow() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterOspf() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterOspf6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterPolicy6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterPrefixList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterPrefixList6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterRip() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterRipng() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterRouteMap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterStatic() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllRouterStatic6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSshFilterProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchcontrollerAutoconfigDefault() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerGlobal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchcontrollerInitialconfigTemplate() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchcontrollerInitialconfigVlans() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerLldpProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerLldpSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerLocation() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerMacPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerManagedSwitch() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerNacDevice() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerNacSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerPortPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchcontrollerSecuritypolicy8021x() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerSnmpCommunity() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerStpInstance() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerStpSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerSwitchGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerSystem() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSwitchControllerVlanPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystem3gmodemCustom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAccprofile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAdmin() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAlarm() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemApiUser() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemArpTable() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutoInstall() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutomationAction() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutomationDestination() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutomationStitch() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutomationTrigger() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutoScript() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutoupdatePushUpdate() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutoupdateSchedule() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemAutoupdateTunneling() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemCentralManagement() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemClusterSync() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemConsole() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemCsf() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemCustomLanguage() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDdns() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDedicatedMgmt() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDhcp6Server() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDhcpServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDns() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDnsDatabase() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDnsServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemDscpBasedPriority() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemEmailServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemExternalResource() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFipsCc() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFortiguard() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFortimanager() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFortisandbox() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFssoPolling() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemFtmPush() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemGeneve() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemGeoipCountry() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemGeoipOverride() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemGlobal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemGreTunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemHa() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemHaMonitor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemInterface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpipTunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIps() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpsecAggregate() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpsUrlfilterDns() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpsUrlfilterDns6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpv6NeighborCache() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemIpv6Tunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemLinkMonitor() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemLldpNetworkPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemLteModem() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemMacAddressTable() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemMobileTunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemModem() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNat64() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNdProxy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNetflow() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNetworkVisibility() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNpu() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemNtp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemObjectTagging() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemPasswordPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemPasswordPolicyGuestAdmin() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemPhysicalSwitch() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemPppoeInterface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemProbeResponse() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemProxyArp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemPtp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgAdmin() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgAlertmail() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgAuth() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgFortiguardWf() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgFtp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgHttp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgIcap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgImage() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgMail() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgNacQuar() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgSpam() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgSslvpn() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgTrafficQuota() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgUtm() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemReplacemsgWebproxy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemResourceLimits() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSaml() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSdnConnector() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSdwan() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSessionHelper() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSessionTtl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSflow() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSitTunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSmsServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSnmpCommunity() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSnmpSysinfo() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSnmpUser() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSpeedTestServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSsoAdmin() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemStandaloneCluster() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemStorage() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemStp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemSwitchInterface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemTosBasedPriority() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdom() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomDns() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomException() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomLink() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomNetflow() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomProperty() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomRadiusServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVdomSflow() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVirtualSwitch() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVirtualWirePair() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVneTunnel() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemVxlan() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemWccp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllSystemZone() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserAdgrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserDomainController() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserExchange() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserFortitoken() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserFsso() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserFssoPolling() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserKrbKeytab() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserLdap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserLocal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserNacPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserPasswordPolicy() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserPeer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserPeergrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserPop3() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserQuarantine() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserRadius() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserSaml() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserSecurityExemptList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllUserTacacs() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVoipProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateCa() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateCrl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateLocal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateOcspServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateRemote() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnCertificateSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecConcentrator() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecForticlient() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecManualkey() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecManualkeyInterface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecPhase1() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecPhase1Interface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecPhase2() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnIpsecPhase2Interface() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnL2tp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnOcvpn() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnPptp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslWebHostCheckSoftware() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslWebPortal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslWebRealm() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslWebUserBookmark() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllVpnSslWebUserGroupBookmark() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWafMainClass() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWafProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWafSignature() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptAuthGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptCacheService() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptContentDeliveryNetworkRule() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptPeer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptRemoteStorage() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptSettings() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWanoptWebcache() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterContent() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterContentHeader() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterFortiguard() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterFtgdLocalCat() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterFtgdLocalRating() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterIpsUrlfilterCacheSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterIpsUrlfilterSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterIpsUrlfilterSetting6() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterOverride() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterSearchEngine() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebfilterUrlfilter() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyDebugUrl() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyExplicit() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyForwardServer() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyForwardServerGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyGlobal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyUrlMatch() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWebProxyWisp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerAccessControlList() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerAddress() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerAddrgrp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerApcfgProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerApStatus() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerArrpProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerBleProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerBonjourProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerGlobal() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20Anqp3gppCellular() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20AnqpIpAddressType() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20AnqpNaiRealm() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20AnqpNetworkAuthType() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20AnqpRoamingConsortium() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20AnqpVenueName() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20H2qpConnCapability() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20H2qpOperatorName() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20H2qpOsuProvider() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20H2qpWanMetric() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20HsProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20Icon() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelesscontrollerHotspot20QosMap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerInterController() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerLog() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerMpskProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerQosProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerRegion() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerSetting() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerSnmp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerTimers() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerUtmProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerVap() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerVapGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerWagProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerWidsProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerWtp() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerWtpGroup() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAllWirelessControllerWtpProfile() - -  : stdClass -
-
Select all entries in a CLI table.
- -
- getAntivirusProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getApplicationCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getApplicationGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getApplicationList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getApplicationName() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getApplicationRuleSettings() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getAuthenticationRule() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getAuthenticationScheme() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getCertificateCa() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getCertificateCrl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getCertificateLocal() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getCertificateRemote() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getCredentialStoreDomainController() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDlpFilepattern() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDlpFpDocSource() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDlpSensitivity() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDlpSensor() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDnsfilterDomainFilter() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getDnsfilterProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterBwl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterBword() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterDnsbl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterIptrust() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterMheader() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEmailfilterProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getEndpointControlFctems() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getExtenderControllerDataplan() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getExtenderControllerExtender() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFileFilterProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAcl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAcl6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAddress() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAddress6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAddress6Template() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAddrgrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallAddrgrp6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallCentralSnatMap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallCity() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallCountry() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallDecryptedTrafficMirror() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallDnstranslation() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallDosPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallDosPolicy6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallIdentityBasedRoute() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInterfacePolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInterfacePolicy6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetService() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceAddition() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceBotnet() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceCustomGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceDefinition() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceExtension() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceIpblReason() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceIpblVendor() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceName() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceOwner() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceReputation() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallInternetServiceSld() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallIpmacbindingTable() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallIppool() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallIppool6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallIpTranslation() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallLdbMonitor() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallLocalInPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallLocalInPolicy6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallMulticastAddress() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallMulticastAddress6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallMulticastPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallMulticastPolicy6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallPolicy46() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallPolicy64() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallProfileGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallProfileProtocolOptions() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallProxyAddress() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallProxyAddrgrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallProxyPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallRegion() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallScheduleGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallScheduleOnetime() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallScheduleRecurring() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSecurityPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallServiceCategory() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallServiceCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallServiceGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallShaperPerIpShaper() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallShaperTrafficShaper() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallShapingPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallShapingProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSniffer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSshHostKey() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSshLocalCa() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSshLocalKey() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSslServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallSslSshProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallTrafficClass() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallTtlPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVendorMac() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVip() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVip46() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVip6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVip64() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVipgrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVipgrp46() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVipgrp6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallVipgrp64() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallWildcardfqdnCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getFirewallWildcardfqdnGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIcapProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIcapServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsDecoder() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsRule() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsRuleSettings() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsSensor() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getIpsViewMap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getLogCustomField() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getReportChart() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getReportDataset() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getReportLayout() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getReportStyle() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getReportTheme() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterAccessList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterAccessList6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterAspathList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterAuthPath() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterCommunityList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterKeyChain() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterMulticastFlow() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterPolicy6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterPrefixList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterPrefixList6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterRouteMap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterStatic() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getRouterStatic6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSshFilterProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchcontrollerInitialconfigTemplate() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerLldpProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerLocation() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerMacPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerManagedSwitch() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerNacDevice() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerNacSettings() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerPortPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchcontrollerSecuritypolicy8021x() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerSnmpCommunity() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerStpInstance() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerSwitchGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSwitchControllerVlanPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystem3gmodemCustom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAccprofile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAdmin() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemApiUser() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemArpTable() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAutomationAction() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAutomationDestination() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAutomationStitch() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAutomationTrigger() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemAutoScript() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemClusterSync() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemCustomLanguage() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDdns() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDhcp6Server() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDhcpServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDnsDatabase() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDnsServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemDscpBasedPriority() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemExternalResource() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemGeneve() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemGeoipCountry() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemGeoipOverride() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemGreTunnel() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemInterface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpipTunnel() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpsecAggregate() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpsUrlfilterDns() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpsUrlfilterDns6() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpv6NeighborCache() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemIpv6Tunnel() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemLinkMonitor() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemLldpNetworkPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemMacAddressTable() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemMobileTunnel() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemObjectTagging() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemPhysicalSwitch() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemPppoeInterface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemProxyArp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgAdmin() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgAlertmail() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgAuth() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgFortiguardWf() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgFtp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgHttp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgIcap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgImage() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgMail() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgNacQuar() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgSpam() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgSslvpn() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgTrafficQuota() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgUtm() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemReplacemsgWebproxy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSdnConnector() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSessionHelper() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSitTunnel() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSmsServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSnmpCommunity() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSnmpUser() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSpeedTestServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSsoAdmin() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemStorage() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemSwitchInterface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemTosBasedPriority() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVdom() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVdomException() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVdomLink() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVdomProperty() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVdomRadiusServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVirtualSwitch() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVirtualWirePair() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemVxlan() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemWccp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getSystemZone() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserAdgrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserDomainController() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserExchange() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserFortitoken() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserFsso() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserFssoPolling() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserKrbKeytab() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserLdap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserLocal() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserNacPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserPasswordPolicy() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserPeer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserPeergrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserPop3() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserRadius() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserSaml() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserSecurityExemptList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getUserTacacs() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVoipProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnCertificateCa() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnCertificateCrl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnCertificateLocal() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnCertificateOcspServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnCertificateRemote() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecConcentrator() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecForticlient() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecManualkey() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecManualkeyInterface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecPhase1() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecPhase1Interface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecPhase2() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnIpsecPhase2Interface() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnSslWebHostCheckSoftware() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnSslWebPortal() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnSslWebRealm() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnSslWebUserBookmark() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getVpnSslWebUserGroupBookmark() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWafMainClass() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWafProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWafSignature() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWanoptAuthGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWanoptContentDeliveryNetworkRule() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWanoptPeer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWanoptProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterContent() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterContentHeader() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterFtgdLocalCat() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterFtgdLocalRating() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterOverride() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterSearchEngine() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebfilterUrlfilter() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyDebugUrl() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyForwardServer() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyForwardServerGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyUrlMatch() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWebProxyWisp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerAccessControlList() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerAddress() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerAddrgrp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerApcfgProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerApStatus() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerArrpProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerBleProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerBonjourProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20Anqp3gppCellular() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20AnqpIpAddressType() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20AnqpNaiRealm() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20AnqpNetworkAuthType() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20AnqpRoamingConsortium() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20AnqpVenueName() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20H2qpConnCapability() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20H2qpOperatorName() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20H2qpOsuProvider() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20H2qpWanMetric() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20HsProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20Icon() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelesscontrollerHotspot20QosMap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerMpskProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerQosProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerRegion() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerUtmProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerVap() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerVapGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerWagProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerWidsProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerWtp() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerWtpGroup() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- getWirelessControllerWtpProfile() - -  : stdClass -
-
Select a specific entry from a CLI table.
- -
- listTransactions() - -  : bool -
-
List all transactions.
- -
- startTransaction() - -  : bool -
-
Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).
- -
- updateAlertemailSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateAntivirusHeuristic() - -  : stdClass -
-
Update this specific resource.
- -
- updateAntivirusProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateAntivirusQuarantine() - -  : stdClass -
-
Update this specific resource.
- -
- updateAntivirusSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateApplicationCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateApplicationGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateApplicationList() - -  : stdClass -
-
Update this specific resource.
- -
- updateApplicationName() - -  : stdClass -
-
Update this specific resource.
- -
- updateApplicationRuleSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateAuthenticationRule() - -  : stdClass -
-
Update this specific resource.
- -
- updateAuthenticationScheme() - -  : stdClass -
-
Update this specific resource.
- -
- updateAuthenticationSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateCertificateCa() - -  : stdClass -
-
Update this specific resource.
- -
- updateCertificateCrl() - -  : stdClass -
-
Update this specific resource.
- -
- updateCertificateLocal() - -  : stdClass -
-
Update this specific resource.
- -
- updateCertificateRemote() - -  : stdClass -
-
Update this specific resource.
- -
- updateCredentialStoreDomainController() - -  : stdClass -
-
Update this specific resource.
- -
- updateDlpFilepattern() - -  : stdClass -
-
Update this specific resource.
- -
- updateDlpFpDocSource() - -  : stdClass -
-
Update this specific resource.
- -
- updateDlpSensitivity() - -  : stdClass -
-
Update this specific resource.
- -
- updateDlpSensor() - -  : stdClass -
-
Update this specific resource.
- -
- updateDlpSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateDnsfilterDomainFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateDnsfilterProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterBwl() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterBword() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterDnsbl() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterFortishield() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterIptrust() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterMheader() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterOptions() - -  : stdClass -
-
Update this specific resource.
- -
- updateEmailfilterProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateEndpointControlFctems() - -  : stdClass -
-
Update this specific resource.
- -
- updateExtenderControllerDataplan() - -  : stdClass -
-
Update this specific resource.
- -
- updateExtenderControllerExtender() - -  : stdClass -
-
Update this specific resource.
- -
- updateFileFilterProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAcl() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAcl6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAddress() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAddress6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAddress6Template() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAddrgrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAddrgrp6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallAuthPortal() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallCentralSnatMap() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallCity() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallCountry() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallDecryptedTrafficMirror() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallDnstranslation() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallDosPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallDosPolicy6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIdentityBasedRoute() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInterfacePolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInterfacePolicy6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetService() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceAddition() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceAppend() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceBotnet() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceCustomGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceDefinition() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceExtension() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceIpblReason() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceIpblVendor() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceList() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceName() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceOwner() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceReputation() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallInternetServiceSld() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIpmacbindingSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIpmacbindingTable() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIppool() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIppool6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallIpTranslation() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallLdbMonitor() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallLocalInPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallLocalInPolicy6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallMulticastAddress() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallMulticastAddress6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallMulticastPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallMulticastPolicy6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallPolicy46() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallPolicy64() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallProfileGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallProfileProtocolOptions() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallProxyAddress() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallProxyAddrgrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallProxyPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallRegion() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallScheduleGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallScheduleOnetime() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallScheduleRecurring() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSecurityPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallServiceCategory() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallServiceCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallServiceGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallShaperPerIpShaper() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallShaperTrafficShaper() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallShapingPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallShapingProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSniffer() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSshHostKey() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSshLocalCa() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSshLocalKey() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSshSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSslServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSslSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallSslSshProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallTrafficClass() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallTtlPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVendorMac() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVendorMacSummary() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVip() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVip46() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVip6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVip64() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVipgrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVipgrp46() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVipgrp6() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallVipgrp64() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallWildcardfqdnCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateFirewallWildcardfqdnGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateFtpProxyExplicit() - -  : stdClass -
-
Update this specific resource.
- -
- updateIcapProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateIcapServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsDecoder() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsGlobal() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsRule() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsRuleSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsSensor() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateIpsViewMap() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogCustomField() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogDiskFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogDiskSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogEventfilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer2Filter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer2OverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer2OverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer2Setting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer3Filter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer3OverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer3OverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzer3Setting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzercloudFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzercloudOverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzercloudOverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzercloudSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzerFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzerOverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzerOverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortianalyzerSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortiguardFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortiguardOverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortiguardOverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogFortiguardSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogGuiDisplay() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogMemoryFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogMemoryGlobalSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogMemorySetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogNulldeviceFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogNulldeviceSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd2Filter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd2OverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd2OverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd2Setting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd3Filter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd3OverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd3OverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd3Setting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd4Filter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd4OverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd4OverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogd4Setting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogdFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogdOverrideFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogdOverrideSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogSyslogdSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogThreatWeight() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogWebtrendsFilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateLogWebtrendsSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportChart() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportDataset() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportLayout() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportStyle() - -  : stdClass -
-
Update this specific resource.
- -
- updateReportTheme() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterAccessList() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterAccessList6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterAspathList() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterAuthPath() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterBfd() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterBfd6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterBgp() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterCommunityList() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterIsis() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterKeyChain() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterMulticast() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterMulticast6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterMulticastFlow() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterOspf() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterOspf6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterPolicy6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterPrefixList() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterPrefixList6() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterRip() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterRipng() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterRouteMap() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterStatic() - -  : stdClass -
-
Update this specific resource.
- -
- updateRouterStatic6() - -  : stdClass -
-
Update this specific resource.
- -
- updateSshFilterProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchcontrollerAutoconfigDefault() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerGlobal() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchcontrollerInitialconfigTemplate() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchcontrollerInitialconfigVlans() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerLldpProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerLldpSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerLocation() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerMacPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerManagedSwitch() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerNacDevice() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerNacSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerPortPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchcontrollerSecuritypolicy8021x() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerSnmpCommunity() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerStpInstance() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerStpSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerSwitchGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerSystem() - -  : stdClass -
-
Update this specific resource.
- -
- updateSwitchControllerVlanPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystem3gmodemCustom() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAccprofile() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAdmin() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAlarm() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemApiUser() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemArpTable() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutoInstall() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutomationAction() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutomationDestination() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutomationStitch() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutomationTrigger() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutoScript() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutoupdatePushUpdate() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutoupdateSchedule() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemAutoupdateTunneling() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemCentralManagement() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemClusterSync() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemConsole() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemCsf() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemCustomLanguage() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDdns() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDedicatedMgmt() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDhcp6Server() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDhcpServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDns() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDnsDatabase() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDnsServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemDscpBasedPriority() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemEmailServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemExternalResource() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFipsCc() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFortiguard() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFortimanager() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFortisandbox() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFssoPolling() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemFtmPush() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemGeneve() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemGeoipCountry() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemGeoipOverride() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemGlobal() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemGreTunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemHa() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemHaMonitor() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemInterface() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpipTunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIps() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpsecAggregate() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpsUrlfilterDns() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpsUrlfilterDns6() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpv6NeighborCache() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemIpv6Tunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemLinkMonitor() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemLldpNetworkPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemLteModem() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemMacAddressTable() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemMobileTunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemModem() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNat64() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNdProxy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNetflow() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNetworkVisibility() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNpu() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemNtp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemObjectTagging() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemPasswordPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemPasswordPolicyGuestAdmin() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemPhysicalSwitch() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemPppoeInterface() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemProbeResponse() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemProxyArp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemPtp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgAdmin() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgAlertmail() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgAuth() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgFortiguardWf() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgFtp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgHttp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgIcap() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgImage() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgMail() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgNacQuar() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgSpam() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgSslvpn() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgTrafficQuota() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgUtm() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemReplacemsgWebproxy() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemResourceLimits() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSaml() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSdnConnector() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSdwan() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSessionHelper() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSessionTtl() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSflow() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSitTunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSmsServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSnmpCommunity() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSnmpSysinfo() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSnmpUser() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSpeedTestServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSsoAdmin() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemStandaloneCluster() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemStorage() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemStp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemSwitchInterface() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemTosBasedPriority() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdom() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomDns() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomException() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomLink() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomNetflow() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomProperty() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomRadiusServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVdomSflow() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVirtualSwitch() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVirtualWirePair() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVneTunnel() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemVxlan() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemWccp() - -  : stdClass -
-
Update this specific resource.
- -
- updateSystemZone() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserAdgrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserDomainController() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserExchange() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserFortitoken() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserFsso() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserFssoPolling() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserKrbKeytab() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserLdap() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserLocal() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserNacPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserPasswordPolicy() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserPeer() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserPeergrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserPop3() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserQuarantine() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserRadius() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserSaml() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserSecurityExemptList() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateUserTacacs() - -  : stdClass -
-
Update this specific resource.
- -
- updateVoipProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateCa() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateCrl() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateLocal() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateOcspServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateRemote() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnCertificateSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecConcentrator() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecForticlient() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecManualkey() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecManualkeyInterface() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecPhase1() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecPhase1Interface() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecPhase2() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnIpsecPhase2Interface() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnL2tp() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnOcvpn() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnPptp() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslWebHostCheckSoftware() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslWebPortal() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslWebRealm() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslWebUserBookmark() - -  : stdClass -
-
Update this specific resource.
- -
- updateVpnSslWebUserGroupBookmark() - -  : stdClass -
-
Update this specific resource.
- -
- updateWafMainClass() - -  : stdClass -
-
Update this specific resource.
- -
- updateWafProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWafSignature() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptAuthGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptCacheService() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptContentDeliveryNetworkRule() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptPeer() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptRemoteStorage() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptSettings() - -  : stdClass -
-
Update this specific resource.
- -
- updateWanoptWebcache() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterContent() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterContentHeader() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterFortiguard() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterFtgdLocalCat() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterFtgdLocalRating() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterIpsUrlfilterCacheSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterIpsUrlfilterSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterIpsUrlfilterSetting6() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterOverride() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterSearchEngine() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebfilterUrlfilter() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyDebugUrl() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyExplicit() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyForwardServer() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyForwardServerGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyGlobal() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyUrlMatch() - -  : stdClass -
-
Update this specific resource.
- -
- updateWebProxyWisp() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerAccessControlList() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerAddress() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerAddrgrp() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerApcfgProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerApStatus() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerArrpProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerBleProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerBonjourProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerGlobal() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20Anqp3gppCellular() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20AnqpIpAddressType() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20AnqpNaiRealm() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20AnqpNetworkAuthType() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20AnqpRoamingConsortium() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20AnqpVenueName() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20H2qpConnCapability() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20H2qpOperatorName() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20H2qpOsuProvider() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20H2qpWanMetric() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20HsProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20Icon() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelesscontrollerHotspot20QosMap() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerInterController() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerLog() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerMpskProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerQosProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerRegion() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerSetting() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerSnmp() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerTimers() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerUtmProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerVap() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerVapGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerWagProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerWidsProfile() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerWtp() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerWtpGroup() - -  : stdClass -
-
Update this specific resource.
- -
- updateWirelessControllerWtpProfile() - -  : stdClass -
-
Update this specific resource.
- -
- curlRequest() - -  : stdClass -
-
Method to request the firewall's API.
- -
- httpBuildCustomQuery() - -  : string -
-
Function used to build a query with params but following fortigate satndards.
- -
- login() - -  : bool -
-
Login in the firewall.
- -
- logout() - -  : Return -
-
Logout from the firewall.
- -
- - - - - - -
-

- Properties - -

-
-

- $config - - - -

- - - - - public - Config - $config - - -

Config object with all needed information.

-
- - - -
-
-

- $session_key - - - -

- - - - - public - string - $session_key - - -

Authentication token kept in cache.

-
- - - -
-
-

- $transaction - - - -

- - - - - public - int|null - $transaction - - -

Ongoning transaction ID. -WARNING : When going through the method prepareRequestData(), all upper case letter in function parameter name will be replaced by '-' and ;brought down to lower case. If you modify or add new endpoints replace all '-' in parameter name by the next letter in uppercase.

-
- - - -
- -
-

- $session_key - - - -

- - - - - private - string - $session_key - = '' - - - - -
-
-

- $transaction - - - -

- - - - - private - mixed - $transaction - - - - - -
-
- -
-

- Methods - -

-
-

- __construct() - -

- - -

Constructor takes care of checking and registering firewall's data and login to the API

- - - public - __construct(Config $config) : mixed - -
- -
Parameters
-
-
- $config - : Config -
-
-

Object containing all necessary configuration.

-
- -
-
- - - -
Return values
- mixed - — -
- - -
-
-

- __destruct() - -

- - -

Destructor takes care of logout.

- - - public - __destruct() : mixed - -
- - - - -
Return values
- mixed - — -
- - -
-
-

- abortTransaction() - -

- - -

Abort a transaction (rollback operations).

- - - public - abortTransaction([string|null $vdom = null ]) : bool - -
- -
Parameters
-
-
- $vdom - : string|null - = null
-
-

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

-
- -
-
- - - -
Return values
- bool - — -

Return TRUE on success and FALSE on failure.

-
- - -
-
-

- addAntivirusProfile() - -

- - -

Create object(s) in this table.

- - - public - addAntivirusProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /antivirus/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addApplicationCustom() - -

- - -

Create object(s) in this table.

- - - public - addApplicationCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /application/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addApplicationGroup() - -

- - -

Create object(s) in this table.

- - - public - addApplicationGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /application/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addApplicationList() - -

- - -

Create object(s) in this table.

- - - public - addApplicationList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /application/list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addApplicationName() - -

- - -

Create object(s) in this table.

- - - public - addApplicationName( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /application/name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addApplicationRuleSettings() - -

- - -

Create object(s) in this table.

- - - public - addApplicationRuleSettings( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /application/rule-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addAuthenticationRule() - -

- - -

Create object(s) in this table.

- - - public - addAuthenticationRule( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /authentication/rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addAuthenticationScheme() - -

- - -

Create object(s) in this table.

- - - public - addAuthenticationScheme( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /authentication/scheme

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addCertificateCa() - -

- - -

Create object(s) in this table.

- - - public - addCertificateCa( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /certificate/ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addCertificateCrl() - -

- - -

Create object(s) in this table.

- - - public - addCertificateCrl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /certificate/crl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addCertificateLocal() - -

- - -

Create object(s) in this table.

- - - public - addCertificateLocal( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /certificate/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addCertificateRemote() - -

- - -

Create object(s) in this table.

- - - public - addCertificateRemote( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /certificate/remote

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addCredentialStoreDomainController() - -

- - -

Create object(s) in this table.

- - - public - addCredentialStoreDomainController( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /credential-store/domain-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDlpFilepattern() - -

- - -

Create object(s) in this table.

- - - public - addDlpFilepattern( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dlp/filepattern

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDlpFpDocSource() - -

- - -

Create object(s) in this table.

- - - public - addDlpFpDocSource( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dlp/fp-doc-source

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDlpSensitivity() - -

- - -

Create object(s) in this table.

- - - public - addDlpSensitivity( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dlp/sensitivity

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDlpSensor() - -

- - -

Create object(s) in this table.

- - - public - addDlpSensor( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dlp/sensor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDnsfilterDomainFilter() - -

- - -

Create object(s) in this table.

- - - public - addDnsfilterDomainFilter( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dnsfilter/domain-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addDnsfilterProfile() - -

- - -

Create object(s) in this table.

- - - public - addDnsfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /dnsfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterBwl() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterBwl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/bwl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterBword() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterBword( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/bword

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterDnsbl() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterDnsbl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/dnsbl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterIptrust() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterIptrust( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/iptrust

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterMheader() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterMheader( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/mheader

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEmailfilterProfile() - -

- - -

Create object(s) in this table.

- - - public - addEmailfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /emailfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addEndpointControlFctems() - -

- - -

Create object(s) in this table.

- - - public - addEndpointControlFctems( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /endpoint-control/fctems

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addExtenderControllerDataplan() - -

- - -

Create object(s) in this table.

- - - public - addExtenderControllerDataplan( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /extender-controller/dataplan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addExtenderControllerExtender() - -

- - -

Create object(s) in this table.

- - - public - addExtenderControllerExtender( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /extender-controller/extender

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFileFilterProfile() - -

- - -

Create object(s) in this table.

- - - public - addFileFilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /file-filter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAcl() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAcl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/acl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAcl6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAcl6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/acl6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAddress() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAddress( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAddress6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAddress6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/address6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAddress6Template() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAddress6Template( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/address6-template

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAddrgrp() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallAddrgrp6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallAddrgrp6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/addrgrp6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallCentralSnatMap() - -

- - -

Create object(s) in this table.

- - - public - addFirewallCentralSnatMap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/central-snat-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallCity() - -

- - -

Create object(s) in this table.

- - - public - addFirewallCity( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/city

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallCountry() - -

- - -

Create object(s) in this table.

- - - public - addFirewallCountry( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/country

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallDecryptedTrafficMirror() - -

- - -

Create object(s) in this table.

- - - public - addFirewallDecryptedTrafficMirror( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/decrypted-traffic-mirror

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallDnstranslation() - -

- - -

Create object(s) in this table.

- - - public - addFirewallDnstranslation( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/dnstranslation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallDosPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallDosPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/DoS-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallDosPolicy6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallDosPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/DoS-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallIdentityBasedRoute() - -

- - -

Create object(s) in this table.

- - - public - addFirewallIdentityBasedRoute( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/identity-based-route

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInterfacePolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInterfacePolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/interface-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInterfacePolicy6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInterfacePolicy6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/interface-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetService() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetService( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceAddition() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceAddition( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-addition

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceBotnet() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceBotnet( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-botnet

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceCustom() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceCustomGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceCustomGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-custom-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceDefinition() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceDefinition( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-definition

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceExtension() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceExtension( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-extension

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceIpblReason() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceIpblReason( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-ipbl-reason

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceIpblVendor() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceIpblVendor( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-ipbl-vendor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceList() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceName() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceName( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceOwner() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceOwner( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-owner

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceReputation() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceReputation( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-reputation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallInternetServiceSld() - -

- - -

Create object(s) in this table.

- - - public - addFirewallInternetServiceSld( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/internet-service-sld

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallIpmacbindingTable() - -

- - -

Create object(s) in this table.

- - - public - addFirewallIpmacbindingTable( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.ipmacbinding/table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallIppool() - -

- - -

Create object(s) in this table.

- - - public - addFirewallIppool( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ippool

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallIppool6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallIppool6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ippool6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallIpTranslation() - -

- - -

Create object(s) in this table.

- - - public - addFirewallIpTranslation( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ip-translation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallLdbMonitor() - -

- - -

Create object(s) in this table.

- - - public - addFirewallLdbMonitor( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ldb-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallLocalInPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallLocalInPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/local-in-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallLocalInPolicy6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallLocalInPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/local-in-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallMulticastAddress() - -

- - -

Create object(s) in this table.

- - - public - addFirewallMulticastAddress( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/multicast-address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallMulticastAddress6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallMulticastAddress6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/multicast-address6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallMulticastPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallMulticastPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/multicast-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallMulticastPolicy6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallMulticastPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/multicast-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallPolicy46() - -

- - -

Create object(s) in this table.

- - - public - addFirewallPolicy46( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/policy46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallPolicy64() - -

- - -

Create object(s) in this table.

- - - public - addFirewallPolicy64( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/policy64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallProfileGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallProfileGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/profile-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallProfileProtocolOptions() - -

- - -

Create object(s) in this table.

- - - public - addFirewallProfileProtocolOptions( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/profile-protocol-options

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallProxyAddress() - -

- - -

Create object(s) in this table.

- - - public - addFirewallProxyAddress( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/proxy-address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallProxyAddrgrp() - -

- - -

Create object(s) in this table.

- - - public - addFirewallProxyAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/proxy-addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallProxyPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallProxyPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/proxy-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallRegion() - -

- - -

Create object(s) in this table.

- - - public - addFirewallRegion( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/region

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallScheduleGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallScheduleGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.schedule/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallScheduleOnetime() - -

- - -

Create object(s) in this table.

- - - public - addFirewallScheduleOnetime( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.schedule/onetime

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallScheduleRecurring() - -

- - -

Create object(s) in this table.

- - - public - addFirewallScheduleRecurring( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.schedule/recurring

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSecurityPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSecurityPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/security-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallServiceCategory() - -

- - -

Create object(s) in this table.

- - - public - addFirewallServiceCategory( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.service/category

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallServiceCustom() - -

- - -

Create object(s) in this table.

- - - public - addFirewallServiceCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.service/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallServiceGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallServiceGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.service/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallShaperPerIpShaper() - -

- - -

Create object(s) in this table.

- - - public - addFirewallShaperPerIpShaper( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.shaper/per-ip-shaper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallShaperTrafficShaper() - -

- - -

Create object(s) in this table.

- - - public - addFirewallShaperTrafficShaper( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.shaper/traffic-shaper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallShapingPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallShapingPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/shaping-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallShapingProfile() - -

- - -

Create object(s) in this table.

- - - public - addFirewallShapingProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/shaping-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSniffer() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSniffer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/sniffer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSshHostKey() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSshHostKey( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.ssh/host-key

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSshLocalCa() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSshLocalCa( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.ssh/local-ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSshLocalKey() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSshLocalKey( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.ssh/local-key

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSslServer() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSslServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ssl-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallSslSshProfile() - -

- - -

Create object(s) in this table.

- - - public - addFirewallSslSshProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ssl-ssh-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallTrafficClass() - -

- - -

Create object(s) in this table.

- - - public - addFirewallTrafficClass( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/traffic-class

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallTtlPolicy() - -

- - -

Create object(s) in this table.

- - - public - addFirewallTtlPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/ttl-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVendorMac() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVendorMac( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vendor-mac

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVip() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVip( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vip

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVip46() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVip46( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vip46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVip6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVip6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vip6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVip64() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVip64( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vip64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVipgrp() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVipgrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vipgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVipgrp46() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVipgrp46( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vipgrp46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVipgrp6() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVipgrp6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vipgrp6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallVipgrp64() - -

- - -

Create object(s) in this table.

- - - public - addFirewallVipgrp64( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall/vipgrp64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallWildcardfqdnCustom() - -

- - -

Create object(s) in this table.

- - - public - addFirewallWildcardfqdnCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.wildcard-fqdn/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addFirewallWildcardfqdnGroup() - -

- - -

Create object(s) in this table.

- - - public - addFirewallWildcardfqdnGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /firewall.wildcard-fqdn/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIcapProfile() - -

- - -

Create object(s) in this table.

- - - public - addIcapProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /icap/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIcapServer() - -

- - -

Create object(s) in this table.

- - - public - addIcapServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /icap/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsCustom() - -

- - -

Create object(s) in this table.

- - - public - addIpsCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsDecoder() - -

- - -

Create object(s) in this table.

- - - public - addIpsDecoder( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/decoder

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsRule() - -

- - -

Create object(s) in this table.

- - - public - addIpsRule( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsRuleSettings() - -

- - -

Create object(s) in this table.

- - - public - addIpsRuleSettings( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/rule-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsSensor() - -

- - -

Create object(s) in this table.

- - - public - addIpsSensor( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/sensor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addIpsViewMap() - -

- - -

Create object(s) in this table.

- - - public - addIpsViewMap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ips/view-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addLogCustomField() - -

- - -

Create object(s) in this table.

- - - public - addLogCustomField( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /log/custom-field

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addReportChart() - -

- - -

Create object(s) in this table.

- - - public - addReportChart( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /report/chart

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addReportDataset() - -

- - -

Create object(s) in this table.

- - - public - addReportDataset( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /report/dataset

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addReportLayout() - -

- - -

Create object(s) in this table.

- - - public - addReportLayout( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /report/layout

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addReportStyle() - -

- - -

Create object(s) in this table.

- - - public - addReportStyle( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /report/style

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addReportTheme() - -

- - -

Create object(s) in this table.

- - - public - addReportTheme( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /report/theme

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterAccessList() - -

- - -

Create object(s) in this table.

- - - public - addRouterAccessList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/access-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterAccessList6() - -

- - -

Create object(s) in this table.

- - - public - addRouterAccessList6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/access-list6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterAspathList() - -

- - -

Create object(s) in this table.

- - - public - addRouterAspathList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/aspath-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterAuthPath() - -

- - -

Create object(s) in this table.

- - - public - addRouterAuthPath( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/auth-path

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterCommunityList() - -

- - -

Create object(s) in this table.

- - - public - addRouterCommunityList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/community-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterKeyChain() - -

- - -

Create object(s) in this table.

- - - public - addRouterKeyChain( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/key-chain

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterMulticastFlow() - -

- - -

Create object(s) in this table.

- - - public - addRouterMulticastFlow( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/multicast-flow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterPolicy() - -

- - -

Create object(s) in this table.

- - - public - addRouterPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterPolicy6() - -

- - -

Create object(s) in this table.

- - - public - addRouterPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterPrefixList() - -

- - -

Create object(s) in this table.

- - - public - addRouterPrefixList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/prefix-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterPrefixList6() - -

- - -

Create object(s) in this table.

- - - public - addRouterPrefixList6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/prefix-list6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterRouteMap() - -

- - -

Create object(s) in this table.

- - - public - addRouterRouteMap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/route-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterStatic() - -

- - -

Create object(s) in this table.

- - - public - addRouterStatic( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/static

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addRouterStatic6() - -

- - -

Create object(s) in this table.

- - - public - addRouterStatic6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /router/static6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSshFilterProfile() - -

- - -

Create object(s) in this table.

- - - public - addSshFilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /ssh-filter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchcontrollerInitialconfigTemplate() - -

- - -

Create object(s) in this table.

- - - public - addSwitchcontrollerInitialconfigTemplate( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller.initial-config/template

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerLldpProfile() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerLldpProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/lldp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerLocation() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerLocation( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/location

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerMacPolicy() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerMacPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/mac-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerManagedSwitch() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerManagedSwitch( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/managed-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerNacDevice() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerNacDevice( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/nac-device

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerNacSettings() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerNacSettings( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/nac-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerPortPolicy() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerPortPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/port-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchcontrollerSecuritypolicy8021x() - -

- - -

Create object(s) in this table.

- - - public - addSwitchcontrollerSecuritypolicy8021x( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller.security-policy/802-1X

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerSnmpCommunity() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerSnmpCommunity( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/snmp-community

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerStpInstance() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerStpInstance( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/stp-instance

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerSwitchGroup() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerSwitchGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/switch-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSwitchControllerVlanPolicy() - -

- - -

Create object(s) in this table.

- - - public - addSwitchControllerVlanPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /switch-controller/vlan-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystem3gmodemCustom() - -

- - -

Create object(s) in this table.

- - - public - addSystem3gmodemCustom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.3g-modem/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAccprofile() - -

- - -

Create object(s) in this table.

- - - public - addSystemAccprofile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/accprofile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAdmin() - -

- - -

Create object(s) in this table.

- - - public - addSystemAdmin( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemApiUser() - -

- - -

Create object(s) in this table.

- - - public - addSystemApiUser( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/api-user

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemArpTable() - -

- - -

Create object(s) in this table.

- - - public - addSystemArpTable( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/arp-table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAutomationAction() - -

- - -

Create object(s) in this table.

- - - public - addSystemAutomationAction( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/automation-action

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAutomationDestination() - -

- - -

Create object(s) in this table.

- - - public - addSystemAutomationDestination( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/automation-destination

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAutomationStitch() - -

- - -

Create object(s) in this table.

- - - public - addSystemAutomationStitch( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/automation-stitch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAutomationTrigger() - -

- - -

Create object(s) in this table.

- - - public - addSystemAutomationTrigger( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/automation-trigger

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemAutoScript() - -

- - -

Create object(s) in this table.

- - - public - addSystemAutoScript( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/auto-script

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemClusterSync() - -

- - -

Create object(s) in this table.

- - - public - addSystemClusterSync( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/cluster-sync

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemCustomLanguage() - -

- - -

Create object(s) in this table.

- - - public - addSystemCustomLanguage( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/custom-language

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDdns() - -

- - -

Create object(s) in this table.

- - - public - addSystemDdns( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ddns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDhcp6Server() - -

- - -

Create object(s) in this table.

- - - public - addSystemDhcp6Server( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.dhcp6/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDhcpServer() - -

- - -

Create object(s) in this table.

- - - public - addSystemDhcpServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.dhcp/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDnsDatabase() - -

- - -

Create object(s) in this table.

- - - public - addSystemDnsDatabase( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/dns-database

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDnsServer() - -

- - -

Create object(s) in this table.

- - - public - addSystemDnsServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/dns-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemDscpBasedPriority() - -

- - -

Create object(s) in this table.

- - - public - addSystemDscpBasedPriority( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/dscp-based-priority

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemExternalResource() - -

- - -

Create object(s) in this table.

- - - public - addSystemExternalResource( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/external-resource

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemGeneve() - -

- - -

Create object(s) in this table.

- - - public - addSystemGeneve( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/geneve

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemGeoipCountry() - -

- - -

Create object(s) in this table.

- - - public - addSystemGeoipCountry( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/geoip-country

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemGeoipOverride() - -

- - -

Create object(s) in this table.

- - - public - addSystemGeoipOverride( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/geoip-override

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemGreTunnel() - -

- - -

Create object(s) in this table.

- - - public - addSystemGreTunnel( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/gre-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemInterface() - -

- - -

Create object(s) in this table.

- - - public - addSystemInterface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpipTunnel() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpipTunnel( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ipip-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpsecAggregate() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpsecAggregate( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ipsec-aggregate

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpsUrlfilterDns() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpsUrlfilterDns( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ips-urlfilter-dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpsUrlfilterDns6() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpsUrlfilterDns6( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ips-urlfilter-dns6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpv6NeighborCache() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpv6NeighborCache( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ipv6-neighbor-cache

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemIpv6Tunnel() - -

- - -

Create object(s) in this table.

- - - public - addSystemIpv6Tunnel( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/ipv6-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemLinkMonitor() - -

- - -

Create object(s) in this table.

- - - public - addSystemLinkMonitor( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/link-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemLldpNetworkPolicy() - -

- - -

Create object(s) in this table.

- - - public - addSystemLldpNetworkPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.lldp/network-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemMacAddressTable() - -

- - -

Create object(s) in this table.

- - - public - addSystemMacAddressTable( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/mac-address-table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemMobileTunnel() - -

- - -

Create object(s) in this table.

- - - public - addSystemMobileTunnel( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/mobile-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemObjectTagging() - -

- - -

Create object(s) in this table.

- - - public - addSystemObjectTagging( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/object-tagging

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemPhysicalSwitch() - -

- - -

Create object(s) in this table.

- - - public - addSystemPhysicalSwitch( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/physical-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemPppoeInterface() - -

- - -

Create object(s) in this table.

- - - public - addSystemPppoeInterface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/pppoe-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemProxyArp() - -

- - -

Create object(s) in this table.

- - - public - addSystemProxyArp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/proxy-arp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgAdmin() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgAdmin( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgAlertmail() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgAlertmail( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/alertmail

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgAuth() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgAuth( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/auth

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgFortiguardWf() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgFortiguardWf( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/fortiguard-wf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgFtp() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgFtp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/ftp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgGroup() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/replacemsg-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgHttp() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgHttp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/http

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgIcap() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgIcap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/icap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgImage() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgImage( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/replacemsg-image

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgMail() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgMail( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/mail

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgNacQuar() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgNacQuar( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/nac-quar

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgSpam() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgSpam( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/spam

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgSslvpn() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgSslvpn( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/sslvpn

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgTrafficQuota() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgTrafficQuota( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/traffic-quota

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgUtm() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgUtm( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/utm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemReplacemsgWebproxy() - -

- - -

Create object(s) in this table.

- - - public - addSystemReplacemsgWebproxy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.replacemsg/webproxy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSdnConnector() - -

- - -

Create object(s) in this table.

- - - public - addSystemSdnConnector( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/sdn-connector

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSessionHelper() - -

- - -

Create object(s) in this table.

- - - public - addSystemSessionHelper( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/session-helper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSitTunnel() - -

- - -

Create object(s) in this table.

- - - public - addSystemSitTunnel( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/sit-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSmsServer() - -

- - -

Create object(s) in this table.

- - - public - addSystemSmsServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/sms-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSnmpCommunity() - -

- - -

Create object(s) in this table.

- - - public - addSystemSnmpCommunity( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.snmp/community

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSnmpUser() - -

- - -

Create object(s) in this table.

- - - public - addSystemSnmpUser( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system.snmp/user

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSpeedTestServer() - -

- - -

Create object(s) in this table.

- - - public - addSystemSpeedTestServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/speed-test-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSsoAdmin() - -

- - -

Create object(s) in this table.

- - - public - addSystemSsoAdmin( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/sso-admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemStorage() - -

- - -

Create object(s) in this table.

- - - public - addSystemStorage( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/storage

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemSwitchInterface() - -

- - -

Create object(s) in this table.

- - - public - addSystemSwitchInterface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/switch-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemTosBasedPriority() - -

- - -

Create object(s) in this table.

- - - public - addSystemTosBasedPriority( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/tos-based-priority

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVdom() - -

- - -

Create object(s) in this table.

- - - public - addSystemVdom( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vdom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVdomException() - -

- - -

Create object(s) in this table.

- - - public - addSystemVdomException( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vdom-exception

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVdomLink() - -

- - -

Create object(s) in this table.

- - - public - addSystemVdomLink( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vdom-link

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVdomProperty() - -

- - -

Create object(s) in this table.

- - - public - addSystemVdomProperty( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vdom-property

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVdomRadiusServer() - -

- - -

Create object(s) in this table.

- - - public - addSystemVdomRadiusServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vdom-radius-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVirtualSwitch() - -

- - -

Create object(s) in this table.

- - - public - addSystemVirtualSwitch( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/virtual-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVirtualWirePair() - -

- - -

Create object(s) in this table.

- - - public - addSystemVirtualWirePair( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/virtual-wire-pair

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemVxlan() - -

- - -

Create object(s) in this table.

- - - public - addSystemVxlan( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/vxlan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemWccp() - -

- - -

Create object(s) in this table.

- - - public - addSystemWccp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/wccp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addSystemZone() - -

- - -

Create object(s) in this table.

- - - public - addSystemZone( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /system/zone

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserAdgrp() - -

- - -

Create object(s) in this table.

- - - public - addUserAdgrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/adgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserDomainController() - -

- - -

Create object(s) in this table.

- - - public - addUserDomainController( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/domain-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserExchange() - -

- - -

Create object(s) in this table.

- - - public - addUserExchange( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/exchange

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserFortitoken() - -

- - -

Create object(s) in this table.

- - - public - addUserFortitoken( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/fortitoken

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserFsso() - -

- - -

Create object(s) in this table.

- - - public - addUserFsso( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/fsso

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserFssoPolling() - -

- - -

Create object(s) in this table.

- - - public - addUserFssoPolling( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/fsso-polling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserGroup() - -

- - -

Create object(s) in this table.

- - - public - addUserGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserKrbKeytab() - -

- - -

Create object(s) in this table.

- - - public - addUserKrbKeytab( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/krb-keytab

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserLdap() - -

- - -

Create object(s) in this table.

- - - public - addUserLdap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/ldap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserLocal() - -

- - -

Create object(s) in this table.

- - - public - addUserLocal( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserNacPolicy() - -

- - -

Create object(s) in this table.

- - - public - addUserNacPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/nac-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserPasswordPolicy() - -

- - -

Create object(s) in this table.

- - - public - addUserPasswordPolicy( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/password-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserPeer() - -

- - -

Create object(s) in this table.

- - - public - addUserPeer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/peer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserPeergrp() - -

- - -

Create object(s) in this table.

- - - public - addUserPeergrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/peergrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserPop3() - -

- - -

Create object(s) in this table.

- - - public - addUserPop3( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/pop3

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserRadius() - -

- - -

Create object(s) in this table.

- - - public - addUserRadius( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/radius

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserSaml() - -

- - -

Create object(s) in this table.

- - - public - addUserSaml( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/saml

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserSecurityExemptList() - -

- - -

Create object(s) in this table.

- - - public - addUserSecurityExemptList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/security-exempt-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addUserTacacs() - -

- - -

Create object(s) in this table.

- - - public - addUserTacacs( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /user/tacacs+

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVoipProfile() - -

- - -

Create object(s) in this table.

- - - public - addVoipProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /voip/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnCertificateCa() - -

- - -

Create object(s) in this table.

- - - public - addVpnCertificateCa( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.certificate/ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnCertificateCrl() - -

- - -

Create object(s) in this table.

- - - public - addVpnCertificateCrl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.certificate/crl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnCertificateLocal() - -

- - -

Create object(s) in this table.

- - - public - addVpnCertificateLocal( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.certificate/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnCertificateOcspServer() - -

- - -

Create object(s) in this table.

- - - public - addVpnCertificateOcspServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.certificate/ocsp-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnCertificateRemote() - -

- - -

Create object(s) in this table.

- - - public - addVpnCertificateRemote( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.certificate/remote

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecConcentrator() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecConcentrator( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/concentrator

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecForticlient() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecForticlient( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/forticlient

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecManualkey() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecManualkey( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/manualkey

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecManualkeyInterface() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecManualkeyInterface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/manualkey-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecPhase1() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecPhase1( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/phase1

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecPhase1Interface() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecPhase1Interface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/phase1-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecPhase2() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecPhase2( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/phase2

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnIpsecPhase2Interface() - -

- - -

Create object(s) in this table.

- - - public - addVpnIpsecPhase2Interface( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ipsec/phase2-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnSslWebHostCheckSoftware() - -

- - -

Create object(s) in this table.

- - - public - addVpnSslWebHostCheckSoftware( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ssl.web/host-check-software

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnSslWebPortal() - -

- - -

Create object(s) in this table.

- - - public - addVpnSslWebPortal( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ssl.web/portal

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnSslWebRealm() - -

- - -

Create object(s) in this table.

- - - public - addVpnSslWebRealm( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ssl.web/realm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnSslWebUserBookmark() - -

- - -

Create object(s) in this table.

- - - public - addVpnSslWebUserBookmark( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ssl.web/user-bookmark

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addVpnSslWebUserGroupBookmark() - -

- - -

Create object(s) in this table.

- - - public - addVpnSslWebUserGroupBookmark( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /vpn.ssl.web/user-group-bookmark

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWafMainClass() - -

- - -

Create object(s) in this table.

- - - public - addWafMainClass( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /waf/main-class

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWafProfile() - -

- - -

Create object(s) in this table.

- - - public - addWafProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /waf/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWafSignature() - -

- - -

Create object(s) in this table.

- - - public - addWafSignature( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /waf/signature

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWanoptAuthGroup() - -

- - -

Create object(s) in this table.

- - - public - addWanoptAuthGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wanopt/auth-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWanoptContentDeliveryNetworkRule() - -

- - -

Create object(s) in this table.

- - - public - addWanoptContentDeliveryNetworkRule( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wanopt/content-delivery-network-rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWanoptPeer() - -

- - -

Create object(s) in this table.

- - - public - addWanoptPeer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wanopt/peer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWanoptProfile() - -

- - -

Create object(s) in this table.

- - - public - addWanoptProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wanopt/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterContent() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterContent( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/content

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterContentHeader() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterContentHeader( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/content-header

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterFtgdLocalCat() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterFtgdLocalCat( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/ftgd-local-cat

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterFtgdLocalRating() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterFtgdLocalRating( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/ftgd-local-rating

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterOverride() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterOverride( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/override

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterProfile() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterSearchEngine() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterSearchEngine( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/search-engine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebfilterUrlfilter() - -

- - -

Create object(s) in this table.

- - - public - addWebfilterUrlfilter( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /webfilter/urlfilter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyDebugUrl() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyDebugUrl( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/debug-url

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyForwardServer() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyForwardServer( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/forward-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyForwardServerGroup() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyForwardServerGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/forward-server-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyProfile() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyUrlMatch() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyUrlMatch( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/url-match

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWebProxyWisp() - -

- - -

Create object(s) in this table.

- - - public - addWebProxyWisp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /web-proxy/wisp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerAccessControlList() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerAccessControlList( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/access-control-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerAddress() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerAddress( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerAddrgrp() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerApcfgProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerApcfgProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/apcfg-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerApStatus() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerApStatus( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/ap-status

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerArrpProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerArrpProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/arrp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerBleProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerBleProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/ble-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerBonjourProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerBonjourProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/bonjour-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20Anqp3gppCellular() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20Anqp3gppCellular( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-3gpp-cellular

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20AnqpIpAddressType() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20AnqpIpAddressType( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-ip-address-type

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20AnqpNaiRealm() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20AnqpNaiRealm( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-nai-realm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20AnqpNetworkAuthType() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20AnqpNetworkAuthType( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-network-auth-type

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20AnqpRoamingConsortium() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20AnqpRoamingConsortium( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-roaming-consortium

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20AnqpVenueName() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20AnqpVenueName( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/anqp-venue-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20H2qpConnCapability() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20H2qpConnCapability( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/h2qp-conn-capability

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20H2qpOperatorName() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20H2qpOperatorName( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/h2qp-operator-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20H2qpOsuProvider() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20H2qpOsuProvider( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/h2qp-osu-provider

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20H2qpWanMetric() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20H2qpWanMetric( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/h2qp-wan-metric

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20HsProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20HsProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/hs-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20Icon() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20Icon( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/icon

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelesscontrollerHotspot20QosMap() - -

- - -

Create object(s) in this table.

- - - public - addWirelesscontrollerHotspot20QosMap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller.hotspot20/qos-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerMpskProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerMpskProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/mpsk-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerQosProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerQosProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/qos-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerRegion() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerRegion( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/region

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerUtmProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerUtmProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/utm-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerVap() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerVap( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/vap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerVapGroup() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerVapGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/vap-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerWagProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerWagProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/wag-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerWidsProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerWidsProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/wids-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerWtp() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerWtp( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/wtp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerWtpGroup() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerWtpGroup( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/wtp-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- addWirelessControllerWtpProfile() - -

- - -

Create object(s) in this table.

- - - public - addWirelessControllerWtpProfile( $body[,  $vdom = null ][,  $action = null ][,  $nkey = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -clone: Clone this specific resource. -When action=clone is set, the extra parameters nkey must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $nkey - : - = null
-
-

If action=clone, use nkey to specify the ID for the new resource to be created. -For example, to clone address1 to address1_clone, use: -action=clone&nkey=address1_clone -Note: This parameter can only be used when the action parameter is set to clone.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

POST /wireless-controller/wtp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- commitTransaction() - -

- - -

Commit a transaction (apply operations).

- - - public - commitTransaction([string|null $vdom = null ]) : bool - -
- -
Parameters
-
-
- $vdom - : string|null - = null
-
-

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

-
- -
-
- - - -
Return values
- bool - — -

Return TRUE on success and FALSE on failure.

-
- - -
-
-

- deleteAntivirusProfile() - -

- - -

Delete this specific resource.

- - - public - deleteAntivirusProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /antivirus/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteApplicationCustom() - -

- - -

Delete this specific resource.

- - - public - deleteApplicationCustom( $tag[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $tag - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /application/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteApplicationGroup() - -

- - -

Delete this specific resource.

- - - public - deleteApplicationGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /application/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteApplicationList() - -

- - -

Delete this specific resource.

- - - public - deleteApplicationList( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /application/list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteApplicationName() - -

- - -

Delete this specific resource.

- - - public - deleteApplicationName( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /application/name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteApplicationRuleSettings() - -

- - -

Delete this specific resource.

- - - public - deleteApplicationRuleSettings( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /application/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteAuthenticationRule() - -

- - -

Delete this specific resource.

- - - public - deleteAuthenticationRule( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /authentication/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteAuthenticationScheme() - -

- - -

Delete this specific resource.

- - - public - deleteAuthenticationScheme( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /authentication/scheme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteCertificateCa() - -

- - -

Delete this specific resource.

- - - public - deleteCertificateCa( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteCertificateCrl() - -

- - -

Delete this specific resource.

- - - public - deleteCertificateCrl( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteCertificateLocal() - -

- - -

Delete this specific resource.

- - - public - deleteCertificateLocal( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteCertificateRemote() - -

- - -

Delete this specific resource.

- - - public - deleteCertificateRemote( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteCredentialStoreDomainController() - -

- - -

Delete this specific resource.

- - - public - deleteCredentialStoreDomainController( $serverName[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $serverName - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /credential-store/domain-controller/{server-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDlpFilepattern() - -

- - -

Delete this specific resource.

- - - public - deleteDlpFilepattern( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dlp/filepattern/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDlpFpDocSource() - -

- - -

Delete this specific resource.

- - - public - deleteDlpFpDocSource( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dlp/fp-doc-source/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDlpSensitivity() - -

- - -

Delete this specific resource.

- - - public - deleteDlpSensitivity( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dlp/sensitivity/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDlpSensor() - -

- - -

Delete this specific resource.

- - - public - deleteDlpSensor( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dlp/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDnsfilterDomainFilter() - -

- - -

Delete this specific resource.

- - - public - deleteDnsfilterDomainFilter( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dnsfilter/domain-filter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteDnsfilterProfile() - -

- - -

Delete this specific resource.

- - - public - deleteDnsfilterProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /dnsfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterBwl() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterBwl( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/bwl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterBword() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterBword( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/bword/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterDnsbl() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterDnsbl( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/dnsbl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterIptrust() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterIptrust( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/iptrust/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterMheader() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterMheader( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/mheader/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEmailfilterProfile() - -

- - -

Delete this specific resource.

- - - public - deleteEmailfilterProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /emailfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteEndpointControlFctems() - -

- - -

Delete this specific resource.

- - - public - deleteEndpointControlFctems( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /endpoint-control/fctems/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteExtenderControllerDataplan() - -

- - -

Delete this specific resource.

- - - public - deleteExtenderControllerDataplan( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /extender-controller/dataplan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteExtenderControllerExtender() - -

- - -

Delete this specific resource.

- - - public - deleteExtenderControllerExtender( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /extender-controller/extender/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFileFilterProfile() - -

- - -

Delete this specific resource.

- - - public - deleteFileFilterProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /file-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAcl() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAcl( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/acl/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAcl6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAcl6( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/acl6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAddress() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAddress( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAddress6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAddress6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAddress6Template() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAddress6Template( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/address6-template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAddrgrp() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAddrgrp( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallAddrgrp6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallAddrgrp6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/addrgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallCentralSnatMap() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallCentralSnatMap( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/central-snat-map/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallCity() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallCity( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/city/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallCountry() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallCountry( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallDecryptedTrafficMirror() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallDecryptedTrafficMirror( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/decrypted-traffic-mirror/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallDnstranslation() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallDnstranslation( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/dnstranslation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallDosPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallDosPolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/DoS-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallDosPolicy6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallDosPolicy6( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/DoS-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallIdentityBasedRoute() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallIdentityBasedRoute( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/identity-based-route/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInterfacePolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInterfacePolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/interface-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInterfacePolicy6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInterfacePolicy6( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/interface-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetService() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetService( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceAddition() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceAddition( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-addition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceBotnet() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceBotnet( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-botnet/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceCustom() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceCustom( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceCustomGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceCustomGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-custom-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceDefinition() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceDefinition( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-definition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceExtension() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceExtension( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-extension/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceIpblReason() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceIpblReason( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-ipbl-reason/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceIpblVendor() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceIpblVendor( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-ipbl-vendor/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceList() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceList( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-list/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceName() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceName( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceOwner() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceOwner( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-owner/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceReputation() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceReputation( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-reputation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallInternetServiceSld() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallInternetServiceSld( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/internet-service-sld/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallIpmacbindingTable() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallIpmacbindingTable( $seqNum[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $seqNum - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.ipmacbinding/table/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallIppool() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallIppool( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ippool/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallIppool6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallIppool6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ippool6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallIpTranslation() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallIpTranslation( $transid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $transid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ip-translation/{transid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallLdbMonitor() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallLdbMonitor( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ldb-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallLocalInPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallLocalInPolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/local-in-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallLocalInPolicy6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallLocalInPolicy6( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/local-in-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallMulticastAddress() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallMulticastAddress( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/multicast-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallMulticastAddress6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallMulticastAddress6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/multicast-address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallMulticastPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallMulticastPolicy( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/multicast-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallMulticastPolicy6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallMulticastPolicy6( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/multicast-policy6/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallPolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallPolicy46() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallPolicy46( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/policy46/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallPolicy64() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallPolicy64( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/policy64/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallProfileGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallProfileGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/profile-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallProfileProtocolOptions() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallProfileProtocolOptions( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/profile-protocol-options/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallProxyAddress() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallProxyAddress( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/proxy-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallProxyAddrgrp() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallProxyAddrgrp( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/proxy-addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallProxyPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallProxyPolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/proxy-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallRegion() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallRegion( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/region/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallScheduleGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallScheduleGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.schedule/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallScheduleOnetime() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallScheduleOnetime( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.schedule/onetime/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallScheduleRecurring() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallScheduleRecurring( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.schedule/recurring/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSecurityPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSecurityPolicy( $policyid[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $policyid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/security-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallServiceCategory() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallServiceCategory( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.service/category/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallServiceCustom() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallServiceCustom( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.service/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallServiceGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallServiceGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.service/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallShaperPerIpShaper() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallShaperPerIpShaper( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.shaper/per-ip-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallShaperTrafficShaper() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallShaperTrafficShaper( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.shaper/traffic-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallShapingPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallShapingPolicy( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/shaping-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallShapingProfile() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallShapingProfile( $profileName[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $profileName - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/shaping-profile/{profile-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSniffer() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSniffer( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/sniffer/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSshHostKey() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSshHostKey( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.ssh/host-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSshLocalCa() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSshLocalCa( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.ssh/local-ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSshLocalKey() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSshLocalKey( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.ssh/local-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSslServer() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSslServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ssl-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallSslSshProfile() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallSslSshProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ssl-ssh-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallTrafficClass() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallTrafficClass( $classId[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $classId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/traffic-class/{class-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallTtlPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallTtlPolicy( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/ttl-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVendorMac() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVendorMac( $id[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vendor-mac/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVip() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVip( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vip/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVip46() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVip46( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vip46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVip6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVip6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vip6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVip64() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVip64( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vip64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVipgrp() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVipgrp( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vipgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVipgrp46() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVipgrp46( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vipgrp46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVipgrp6() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVipgrp6( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vipgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallVipgrp64() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallVipgrp64( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall/vipgrp64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallWildcardfqdnCustom() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallWildcardfqdnCustom( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.wildcard-fqdn/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteFirewallWildcardfqdnGroup() - -

- - -

Delete this specific resource.

- - - public - deleteFirewallWildcardfqdnGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /firewall.wildcard-fqdn/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIcapProfile() - -

- - -

Delete this specific resource.

- - - public - deleteIcapProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /icap/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIcapServer() - -

- - -

Delete this specific resource.

- - - public - deleteIcapServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /icap/server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsCustom() - -

- - -

Delete this specific resource.

- - - public - deleteIpsCustom( $tag[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $tag - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsDecoder() - -

- - -

Delete this specific resource.

- - - public - deleteIpsDecoder( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/decoder/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsRule() - -

- - -

Delete this specific resource.

- - - public - deleteIpsRule( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsRuleSettings() - -

- - -

Delete this specific resource.

- - - public - deleteIpsRuleSettings( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsSensor() - -

- - -

Delete this specific resource.

- - - public - deleteIpsSensor( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteIpsViewMap() - -

- - -

Delete this specific resource.

- - - public - deleteIpsViewMap( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ips/view-map/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteLogCustomField() - -

- - -

Delete this specific resource.

- - - public - deleteLogCustomField( $id[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /log/custom-field/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteReportChart() - -

- - -

Delete this specific resource.

- - - public - deleteReportChart( $name[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /report/chart/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteReportDataset() - -

- - -

Delete this specific resource.

- - - public - deleteReportDataset( $name[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /report/dataset/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteReportLayout() - -

- - -

Delete this specific resource.

- - - public - deleteReportLayout( $name[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /report/layout/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteReportStyle() - -

- - -

Delete this specific resource.

- - - public - deleteReportStyle( $name[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /report/style/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteReportTheme() - -

- - -

Delete this specific resource.

- - - public - deleteReportTheme( $name[,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /report/theme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterAccessList() - -

- - -

Delete this specific resource.

- - - public - deleteRouterAccessList( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/access-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterAccessList6() - -

- - -

Delete this specific resource.

- - - public - deleteRouterAccessList6( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/access-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterAspathList() - -

- - -

Delete this specific resource.

- - - public - deleteRouterAspathList( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/aspath-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterAuthPath() - -

- - -

Delete this specific resource.

- - - public - deleteRouterAuthPath( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/auth-path/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterCommunityList() - -

- - -

Delete this specific resource.

- - - public - deleteRouterCommunityList( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/community-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterKeyChain() - -

- - -

Delete this specific resource.

- - - public - deleteRouterKeyChain( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/key-chain/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterMulticastFlow() - -

- - -

Delete this specific resource.

- - - public - deleteRouterMulticastFlow( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/multicast-flow/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteRouterPolicy( $seqNum[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $seqNum - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/policy/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterPolicy6() - -

- - -

Delete this specific resource.

- - - public - deleteRouterPolicy6( $seqNum[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $seqNum - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/policy6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterPrefixList() - -

- - -

Delete this specific resource.

- - - public - deleteRouterPrefixList( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/prefix-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterPrefixList6() - -

- - -

Delete this specific resource.

- - - public - deleteRouterPrefixList6( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/prefix-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterRouteMap() - -

- - -

Delete this specific resource.

- - - public - deleteRouterRouteMap( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/route-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterStatic() - -

- - -

Delete this specific resource.

- - - public - deleteRouterStatic( $seqNum[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $seqNum - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/static/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteRouterStatic6() - -

- - -

Delete this specific resource.

- - - public - deleteRouterStatic6( $seqNum[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $seqNum - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /router/static6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSshFilterProfile() - -

- - -

Delete this specific resource.

- - - public - deleteSshFilterProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /ssh-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchcontrollerInitialconfigTemplate() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchcontrollerInitialconfigTemplate( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller.initial-config/template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerLldpProfile() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerLldpProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/lldp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerLocation() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerLocation( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/location/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerMacPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerMacPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/mac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerManagedSwitch() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerManagedSwitch( $switchId[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $switchId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/managed-switch/{switch-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerNacDevice() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerNacDevice( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/nac-device/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerNacSettings() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerNacSettings( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/nac-settings/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerPortPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerPortPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/port-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchcontrollerSecuritypolicy8021x() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchcontrollerSecuritypolicy8021x( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller.security-policy/802-1X/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerSnmpCommunity() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerSnmpCommunity( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/snmp-community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerStpInstance() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerStpInstance( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/stp-instance/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerSwitchGroup() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerSwitchGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/switch-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSwitchControllerVlanPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteSwitchControllerVlanPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /switch-controller/vlan-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystem3gmodemCustom() - -

- - -

Delete this specific resource.

- - - public - deleteSystem3gmodemCustom( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.3g-modem/custom/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAccprofile() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAccprofile( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/accprofile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAdmin() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAdmin( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemApiUser() - -

- - -

Delete this specific resource.

- - - public - deleteSystemApiUser( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/api-user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemArpTable() - -

- - -

Delete this specific resource.

- - - public - deleteSystemArpTable( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/arp-table/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAutomationAction() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAutomationAction( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/automation-action/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAutomationDestination() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAutomationDestination( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/automation-destination/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAutomationStitch() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAutomationStitch( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/automation-stitch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAutomationTrigger() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAutomationTrigger( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/automation-trigger/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemAutoScript() - -

- - -

Delete this specific resource.

- - - public - deleteSystemAutoScript( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/auto-script/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemClusterSync() - -

- - -

Delete this specific resource.

- - - public - deleteSystemClusterSync( $syncId[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $syncId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/cluster-sync/{sync-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemCustomLanguage() - -

- - -

Delete this specific resource.

- - - public - deleteSystemCustomLanguage( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/custom-language/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDdns() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDdns( $ddnsid[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $ddnsid - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ddns/{ddnsid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDhcp6Server() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDhcp6Server( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.dhcp6/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDhcpServer() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDhcpServer( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.dhcp/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDnsDatabase() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDnsDatabase( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/dns-database/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDnsServer() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDnsServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/dns-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemDscpBasedPriority() - -

- - -

Delete this specific resource.

- - - public - deleteSystemDscpBasedPriority( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/dscp-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemExternalResource() - -

- - -

Delete this specific resource.

- - - public - deleteSystemExternalResource( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/external-resource/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemGeneve() - -

- - -

Delete this specific resource.

- - - public - deleteSystemGeneve( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/geneve/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemGeoipCountry() - -

- - -

Delete this specific resource.

- - - public - deleteSystemGeoipCountry( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/geoip-country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemGeoipOverride() - -

- - -

Delete this specific resource.

- - - public - deleteSystemGeoipOverride( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/geoip-override/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemGreTunnel() - -

- - -

Delete this specific resource.

- - - public - deleteSystemGreTunnel( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/gre-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemInterface() - -

- - -

Delete this specific resource.

- - - public - deleteSystemInterface( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpipTunnel() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpipTunnel( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ipip-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpsecAggregate() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpsecAggregate( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ipsec-aggregate/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpsUrlfilterDns() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpsUrlfilterDns( $address[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $address - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ips-urlfilter-dns/{address}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpsUrlfilterDns6() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpsUrlfilterDns6( $address6[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $address6 - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ips-urlfilter-dns6/{address6}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpv6NeighborCache() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpv6NeighborCache( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ipv6-neighbor-cache/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemIpv6Tunnel() - -

- - -

Delete this specific resource.

- - - public - deleteSystemIpv6Tunnel( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/ipv6-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemLinkMonitor() - -

- - -

Delete this specific resource.

- - - public - deleteSystemLinkMonitor( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/link-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemLldpNetworkPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteSystemLldpNetworkPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.lldp/network-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemMacAddressTable() - -

- - -

Delete this specific resource.

- - - public - deleteSystemMacAddressTable( $mac[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $mac - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/mac-address-table/{mac}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemMobileTunnel() - -

- - -

Delete this specific resource.

- - - public - deleteSystemMobileTunnel( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/mobile-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemObjectTagging() - -

- - -

Delete this specific resource.

- - - public - deleteSystemObjectTagging( $category[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $category - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/object-tagging/{category}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemPhysicalSwitch() - -

- - -

Delete this specific resource.

- - - public - deleteSystemPhysicalSwitch( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/physical-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemPppoeInterface() - -

- - -

Delete this specific resource.

- - - public - deleteSystemPppoeInterface( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/pppoe-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemProxyArp() - -

- - -

Delete this specific resource.

- - - public - deleteSystemProxyArp( $id[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/proxy-arp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgAdmin() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgAdmin( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/admin/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgAlertmail() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgAlertmail( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/alertmail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgAuth() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgAuth( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/auth/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgFortiguardWf() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgFortiguardWf( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/fortiguard-wf/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgFtp() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgFtp( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/ftp/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgGroup() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/replacemsg-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgHttp() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgHttp( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/http/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgIcap() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgIcap( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/icap/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgImage() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgImage( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/replacemsg-image/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgMail() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgMail( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/mail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgNacQuar() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgNacQuar( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/nac-quar/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgSpam() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgSpam( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/spam/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgSslvpn() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgSslvpn( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/sslvpn/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgTrafficQuota() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgTrafficQuota( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/traffic-quota/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgUtm() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgUtm( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/utm/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemReplacemsgWebproxy() - -

- - -

Delete this specific resource.

- - - public - deleteSystemReplacemsgWebproxy( $msgType[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $msgType - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.replacemsg/webproxy/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSdnConnector() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSdnConnector( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/sdn-connector/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSessionHelper() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSessionHelper( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/session-helper/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSitTunnel() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSitTunnel( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/sit-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSmsServer() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSmsServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/sms-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSnmpCommunity() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSnmpCommunity( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.snmp/community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSnmpUser() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSnmpUser( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system.snmp/user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSpeedTestServer() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSpeedTestServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/speed-test-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSsoAdmin() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSsoAdmin( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/sso-admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemStorage() - -

- - -

Delete this specific resource.

- - - public - deleteSystemStorage( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/storage/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemSwitchInterface() - -

- - -

Delete this specific resource.

- - - public - deleteSystemSwitchInterface( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/switch-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemTosBasedPriority() - -

- - -

Delete this specific resource.

- - - public - deleteSystemTosBasedPriority( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/tos-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVdom() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVdom( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vdom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVdomException() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVdomException( $id[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vdom-exception/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVdomLink() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVdomLink( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vdom-link/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVdomProperty() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVdomProperty( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vdom-property/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVdomRadiusServer() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVdomRadiusServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vdom-radius-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVirtualSwitch() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVirtualSwitch( $name[,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/virtual-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVirtualWirePair() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVirtualWirePair( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/virtual-wire-pair/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemVxlan() - -

- - -

Delete this specific resource.

- - - public - deleteSystemVxlan( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/vxlan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemWccp() - -

- - -

Delete this specific resource.

- - - public - deleteSystemWccp( $serviceId[,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $serviceId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/wccp/{service-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteSystemZone() - -

- - -

Delete this specific resource.

- - - public - deleteSystemZone( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /system/zone/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserAdgrp() - -

- - -

Delete this specific resource.

- - - public - deleteUserAdgrp( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/adgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserDomainController() - -

- - -

Delete this specific resource.

- - - public - deleteUserDomainController( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/domain-controller/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserExchange() - -

- - -

Delete this specific resource.

- - - public - deleteUserExchange( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/exchange/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserFortitoken() - -

- - -

Delete this specific resource.

- - - public - deleteUserFortitoken( $serialNumber[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $serialNumber - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/fortitoken/{serial-number}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserFsso() - -

- - -

Delete this specific resource.

- - - public - deleteUserFsso( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/fsso/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserFssoPolling() - -

- - -

Delete this specific resource.

- - - public - deleteUserFssoPolling( $id[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/fsso-polling/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserGroup() - -

- - -

Delete this specific resource.

- - - public - deleteUserGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserKrbKeytab() - -

- - -

Delete this specific resource.

- - - public - deleteUserKrbKeytab( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/krb-keytab/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserLdap() - -

- - -

Delete this specific resource.

- - - public - deleteUserLdap( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/ldap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserLocal() - -

- - -

Delete this specific resource.

- - - public - deleteUserLocal( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserNacPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteUserNacPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/nac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserPasswordPolicy() - -

- - -

Delete this specific resource.

- - - public - deleteUserPasswordPolicy( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/password-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserPeer() - -

- - -

Delete this specific resource.

- - - public - deleteUserPeer( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/peer/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserPeergrp() - -

- - -

Delete this specific resource.

- - - public - deleteUserPeergrp( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/peergrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserPop3() - -

- - -

Delete this specific resource.

- - - public - deleteUserPop3( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/pop3/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserRadius() - -

- - -

Delete this specific resource.

- - - public - deleteUserRadius( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/radius/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserSaml() - -

- - -

Delete this specific resource.

- - - public - deleteUserSaml( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/saml/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserSecurityExemptList() - -

- - -

Delete this specific resource.

- - - public - deleteUserSecurityExemptList( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/security-exempt-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteUserTacacs() - -

- - -

Delete this specific resource.

- - - public - deleteUserTacacs( $name[,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /user/tacacs+/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVoipProfile() - -

- - -

Delete this specific resource.

- - - public - deleteVoipProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /voip/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnCertificateCa() - -

- - -

Delete this specific resource.

- - - public - deleteVpnCertificateCa( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnCertificateCrl() - -

- - -

Delete this specific resource.

- - - public - deleteVpnCertificateCrl( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnCertificateLocal() - -

- - -

Delete this specific resource.

- - - public - deleteVpnCertificateLocal( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnCertificateOcspServer() - -

- - -

Delete this specific resource.

- - - public - deleteVpnCertificateOcspServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.certificate/ocsp-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnCertificateRemote() - -

- - -

Delete this specific resource.

- - - public - deleteVpnCertificateRemote( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecConcentrator() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecConcentrator( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/concentrator/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecForticlient() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecForticlient( $realm[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $realm - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/forticlient/{realm}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecManualkey() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecManualkey( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/manualkey/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecManualkeyInterface() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecManualkeyInterface( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/manualkey-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecPhase1() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecPhase1( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/phase1/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecPhase1Interface() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecPhase1Interface( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/phase1-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecPhase2() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecPhase2( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/phase2/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnIpsecPhase2Interface() - -

- - -

Delete this specific resource.

- - - public - deleteVpnIpsecPhase2Interface( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ipsec/phase2-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnSslWebHostCheckSoftware() - -

- - -

Delete this specific resource.

- - - public - deleteVpnSslWebHostCheckSoftware( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ssl.web/host-check-software/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnSslWebPortal() - -

- - -

Delete this specific resource.

- - - public - deleteVpnSslWebPortal( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ssl.web/portal/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnSslWebRealm() - -

- - -

Delete this specific resource.

- - - public - deleteVpnSslWebRealm( $urlPath[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $urlPath - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ssl.web/realm/{url-path}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnSslWebUserBookmark() - -

- - -

Delete this specific resource.

- - - public - deleteVpnSslWebUserBookmark( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ssl.web/user-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteVpnSslWebUserGroupBookmark() - -

- - -

Delete this specific resource.

- - - public - deleteVpnSslWebUserGroupBookmark( $name[,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /vpn.ssl.web/user-group-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWafMainClass() - -

- - -

Delete this specific resource.

- - - public - deleteWafMainClass( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /waf/main-class/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWafProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWafProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /waf/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWafSignature() - -

- - -

Delete this specific resource.

- - - public - deleteWafSignature( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /waf/signature/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWanoptAuthGroup() - -

- - -

Delete this specific resource.

- - - public - deleteWanoptAuthGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wanopt/auth-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWanoptContentDeliveryNetworkRule() - -

- - -

Delete this specific resource.

- - - public - deleteWanoptContentDeliveryNetworkRule( $name[,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wanopt/content-delivery-network-rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWanoptPeer() - -

- - -

Delete this specific resource.

- - - public - deleteWanoptPeer( $peerHostId[,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $peerHostId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wanopt/peer/{peer-host-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWanoptProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWanoptProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wanopt/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterContent() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterContent( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/content/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterContentHeader() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterContentHeader( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/content-header/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterFtgdLocalCat() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterFtgdLocalCat( $desc[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $desc - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/ftgd-local-cat/{desc}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterFtgdLocalRating() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterFtgdLocalRating( $url[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $url - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/ftgd-local-rating/{url}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterOverride() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterOverride( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/override/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterSearchEngine() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterSearchEngine( $name[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/search-engine/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebfilterUrlfilter() - -

- - -

Delete this specific resource.

- - - public - deleteWebfilterUrlfilter( $id[,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /webfilter/urlfilter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyDebugUrl() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyDebugUrl( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/debug-url/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyForwardServer() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyForwardServer( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/forward-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyForwardServerGroup() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyForwardServerGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/forward-server-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyUrlMatch() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyUrlMatch( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/url-match/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWebProxyWisp() - -

- - -

Delete this specific resource.

- - - public - deleteWebProxyWisp( $name[,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /web-proxy/wisp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerAccessControlList() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerAccessControlList( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/access-control-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerAddress() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerAddress( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/address/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerAddrgrp() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerAddrgrp( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/addrgrp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerApcfgProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerApcfgProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/apcfg-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerApStatus() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerApStatus( $id[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $id - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/ap-status/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerArrpProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerArrpProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/arrp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerBleProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerBleProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/ble-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerBonjourProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerBonjourProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/bonjour-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20Anqp3gppCellular() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20Anqp3gppCellular( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-3gpp-cellular/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20AnqpIpAddressType() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20AnqpIpAddressType( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-ip-address-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20AnqpNaiRealm() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20AnqpNaiRealm( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-nai-realm/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20AnqpNetworkAuthType() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20AnqpNetworkAuthType( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-network-auth-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20AnqpRoamingConsortium() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20AnqpRoamingConsortium( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-roaming-consortium/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20AnqpVenueName() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20AnqpVenueName( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/anqp-venue-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20H2qpConnCapability() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20H2qpConnCapability( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/h2qp-conn-capability/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20H2qpOperatorName() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20H2qpOperatorName( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/h2qp-operator-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20H2qpOsuProvider() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20H2qpOsuProvider( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/h2qp-osu-provider/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20H2qpWanMetric() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20H2qpWanMetric( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/h2qp-wan-metric/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20HsProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20HsProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/hs-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20Icon() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20Icon( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/icon/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelesscontrollerHotspot20QosMap() - -

- - -

Delete this specific resource.

- - - public - deleteWirelesscontrollerHotspot20QosMap( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller.hotspot20/qos-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerMpskProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerMpskProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/mpsk-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerQosProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerQosProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/qos-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerRegion() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerRegion( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/region/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerUtmProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerUtmProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/utm-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerVap() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerVap( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/vap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerVapGroup() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerVapGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/vap-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerWagProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerWagProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/wag-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerWidsProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerWidsProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/wids-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerWtp() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerWtp( $wtpId[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $wtpId - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/wtp/{wtp-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerWtpGroup() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerWtpGroup( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/wtp-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- deleteWirelessControllerWtpProfile() - -

- - -

Delete this specific resource.

- - - public - deleteWirelessControllerWtpProfile( $name[,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $name - : -
-
-

mkey

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

DELETE /wireless-controller/wtp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAlertemailSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAlertemailSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /alertemail/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAntivirusHeuristic() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAntivirusHeuristic([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /antivirus/heuristic

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAntivirusProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAntivirusProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /antivirus/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAntivirusQuarantine() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAntivirusQuarantine([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /antivirus/quarantine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAntivirusSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAntivirusSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /antivirus/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllApplicationCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllApplicationCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllApplicationGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllApplicationGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllApplicationList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllApplicationList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllApplicationName() - -

- - -

Select all entries in a CLI table.

- - - public - getAllApplicationName([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllApplicationRuleSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllApplicationRuleSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/rule-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAuthenticationRule() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAuthenticationRule([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /authentication/rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAuthenticationScheme() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAuthenticationScheme([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /authentication/scheme

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllAuthenticationSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllAuthenticationSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /authentication/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllCertificateCa() - -

- - -

Select all entries in a CLI table.

- - - public - getAllCertificateCa([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllCertificateCrl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllCertificateCrl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/crl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllCertificateLocal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllCertificateLocal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllCertificateRemote() - -

- - -

Select all entries in a CLI table.

- - - public - getAllCertificateRemote([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/remote

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllCredentialStoreDomainController() - -

- - -

Select all entries in a CLI table.

- - - public - getAllCredentialStoreDomainController([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /credential-store/domain-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDlpFilepattern() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDlpFilepattern([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/filepattern

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDlpFpDocSource() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDlpFpDocSource([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/fp-doc-source

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDlpSensitivity() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDlpSensitivity([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/sensitivity

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDlpSensor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDlpSensor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/sensor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDlpSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDlpSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDnsfilterDomainFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDnsfilterDomainFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dnsfilter/domain-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllDnsfilterProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllDnsfilterProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dnsfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterBwl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterBwl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/bwl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterBword() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterBword([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/bword

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterDnsbl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterDnsbl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/dnsbl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterFortishield() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterFortishield([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/fortishield

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterIptrust() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterIptrust([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/iptrust

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterMheader() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterMheader([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/mheader

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterOptions() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterOptions([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/options

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEmailfilterProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEmailfilterProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllEndpointControlFctems() - -

- - -

Select all entries in a CLI table.

- - - public - getAllEndpointControlFctems([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /endpoint-control/fctems

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllExtenderControllerDataplan() - -

- - -

Select all entries in a CLI table.

- - - public - getAllExtenderControllerDataplan([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /extender-controller/dataplan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllExtenderControllerExtender() - -

- - -

Select all entries in a CLI table.

- - - public - getAllExtenderControllerExtender([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /extender-controller/extender

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFileFilterProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFileFilterProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /file-filter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAcl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAcl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/acl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAcl6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAcl6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/acl6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAddress() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAddress([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAddress6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAddress6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAddress6Template() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAddress6Template([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address6-template

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAddrgrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAddrgrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAddrgrp6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAddrgrp6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/addrgrp6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallAuthPortal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallAuthPortal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/auth-portal

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallCentralSnatMap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallCentralSnatMap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/central-snat-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallCity() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallCity([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/city

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallCountry() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallCountry([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/country

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallDecryptedTrafficMirror() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallDecryptedTrafficMirror([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/decrypted-traffic-mirror

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallDnstranslation() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallDnstranslation([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/dnstranslation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallDosPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallDosPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/DoS-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallDosPolicy6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallDosPolicy6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/DoS-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIdentityBasedRoute() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIdentityBasedRoute([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/identity-based-route

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInterfacePolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInterfacePolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/interface-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInterfacePolicy6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInterfacePolicy6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/interface-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetService() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetService([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceAddition() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceAddition([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-addition

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceAppend() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceAppend([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-append

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceBotnet() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceBotnet([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-botnet

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceCustomGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceCustomGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-custom-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceDefinition() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceDefinition([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-definition

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceExtension() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceExtension([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-extension

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceIpblReason() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceIpblReason([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-ipbl-reason

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceIpblVendor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceIpblVendor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-ipbl-vendor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceName() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceName([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceOwner() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceOwner([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-owner

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceReputation() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceReputation([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-reputation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallInternetServiceSld() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallInternetServiceSld([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-sld

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIpmacbindingSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIpmacbindingSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ipmacbinding/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIpmacbindingTable() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIpmacbindingTable([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ipmacbinding/table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIppool() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIppool([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ippool

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIppool6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIppool6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ippool6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallIpTranslation() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallIpTranslation([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ip-translation

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallLdbMonitor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallLdbMonitor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ldb-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallLocalInPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallLocalInPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/local-in-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallLocalInPolicy6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallLocalInPolicy6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/local-in-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallMulticastAddress() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallMulticastAddress([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallMulticastAddress6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallMulticastAddress6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-address6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallMulticastPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallMulticastPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallMulticastPolicy6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallMulticastPolicy6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallPolicy46() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallPolicy46([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallPolicy64() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallPolicy64([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallProfileGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallProfileGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/profile-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallProfileProtocolOptions() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallProfileProtocolOptions([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/profile-protocol-options

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallProxyAddress() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallProxyAddress([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallProxyAddrgrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallProxyAddrgrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallProxyPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallProxyPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallRegion() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallRegion([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/region

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallScheduleGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallScheduleGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallScheduleOnetime() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallScheduleOnetime([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/onetime

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallScheduleRecurring() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallScheduleRecurring([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/recurring

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSecurityPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSecurityPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/security-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallServiceCategory() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallServiceCategory([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/category

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallServiceCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallServiceCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallServiceGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallServiceGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallShaperPerIpShaper() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallShaperPerIpShaper([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.shaper/per-ip-shaper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallShaperTrafficShaper() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallShaperTrafficShaper([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.shaper/traffic-shaper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallShapingPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallShapingPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/shaping-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallShapingProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallShapingProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/shaping-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSniffer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSniffer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/sniffer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSshHostKey() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSshHostKey([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/host-key

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSshLocalCa() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSshLocalCa([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/local-ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSshLocalKey() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSshLocalKey([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/local-key

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSshSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSshSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSslServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSslServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ssl-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSslSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSslSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssl/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallSslSshProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallSslSshProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ssl-ssh-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallTrafficClass() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallTrafficClass([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/traffic-class

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallTtlPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallTtlPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ttl-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVendorMac() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVendorMac([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vendor-mac

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVendorMacSummary() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVendorMacSummary([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vendor-mac-summary

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVip() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVip([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVip46() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVip46([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVip6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVip6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVip64() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVip64([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVipgrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVipgrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVipgrp46() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVipgrp46([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp46

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVipgrp6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVipgrp6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallVipgrp64() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallVipgrp64([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallWildcardfqdnCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallWildcardfqdnCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.wildcard-fqdn/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFirewallWildcardfqdnGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFirewallWildcardfqdnGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.wildcard-fqdn/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllFtpProxyExplicit() - -

- - -

Select all entries in a CLI table.

- - - public - getAllFtpProxyExplicit([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ftp-proxy/explicit

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIcapProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIcapProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /icap/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIcapServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIcapServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /icap/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsDecoder() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsDecoder([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/decoder

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsGlobal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsGlobal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsRule() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsRule([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsRuleSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsRuleSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/rule-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsSensor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsSensor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/sensor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllIpsViewMap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllIpsViewMap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/view-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogCustomField() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogCustomField([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/custom-field

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogDiskFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogDiskFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.disk/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogDiskSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogDiskSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.disk/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogEventfilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogEventfilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/eventfilter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer2Filter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer2Filter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer2/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer2OverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer2OverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer2/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer2OverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer2OverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer2/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer2Setting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer2Setting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer2/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer3Filter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer3Filter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer3/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer3OverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer3OverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer3/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer3OverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer3OverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer3/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzer3Setting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzer3Setting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer3/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzercloudFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzercloudFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer-cloud/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzercloudOverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzercloudOverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer-cloud/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzercloudOverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzercloudOverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer-cloud/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzercloudSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzercloudSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer-cloud/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzerFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzerFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzerOverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzerOverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzerOverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzerOverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortianalyzerSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortianalyzerSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortianalyzer/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortiguardFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortiguardFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortiguard/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortiguardOverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortiguardOverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortiguard/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortiguardOverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortiguardOverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortiguard/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogFortiguardSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogFortiguardSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.fortiguard/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogGuiDisplay() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogGuiDisplay([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/gui-display

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogMemoryFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogMemoryFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.memory/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogMemoryGlobalSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogMemoryGlobalSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.memory/global-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogMemorySetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogMemorySetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.memory/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogNulldeviceFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogNulldeviceFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.null-device/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogNulldeviceSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogNulldeviceSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.null-device/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd2Filter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd2Filter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd2/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd2OverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd2OverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd2/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd2OverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd2OverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd2/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd2Setting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd2Setting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd2/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd3Filter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd3Filter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd3/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd3OverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd3OverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd3/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd3OverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd3OverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd3/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd3Setting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd3Setting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd3/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd4Filter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd4Filter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd4/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd4OverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd4OverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd4/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd4OverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd4OverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd4/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogd4Setting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogd4Setting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd4/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogdFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogdFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogdOverrideFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogdOverrideFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogdOverrideSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogdOverrideSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogSyslogdSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogSyslogdSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.syslogd/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogThreatWeight() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogThreatWeight([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/threat-weight

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogWebtrendsFilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogWebtrendsFilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.webtrends/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllLogWebtrendsSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllLogWebtrendsSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log.webtrends/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportChart() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportChart([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/chart

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportDataset() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportDataset([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/dataset

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportLayout() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportLayout([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/layout

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportStyle() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportStyle([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/style

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllReportTheme() - -

- - -

Select all entries in a CLI table.

- - - public - getAllReportTheme([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/theme

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterAccessList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterAccessList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/access-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterAccessList6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterAccessList6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/access-list6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterAspathList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterAspathList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/aspath-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterAuthPath() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterAuthPath([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/auth-path

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterBfd() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterBfd([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/bfd

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterBfd6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterBfd6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/bfd6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterBgp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterBgp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/bgp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterCommunityList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterCommunityList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/community-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterIsis() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterIsis([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/isis

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterKeyChain() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterKeyChain([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/key-chain

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterMulticast() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterMulticast([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/multicast

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterMulticast6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterMulticast6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/multicast6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterMulticastFlow() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterMulticastFlow([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/multicast-flow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterOspf() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterOspf([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/ospf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterOspf6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterOspf6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/ospf6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterPolicy6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterPolicy6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/policy6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterPrefixList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterPrefixList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/prefix-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterPrefixList6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterPrefixList6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/prefix-list6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterRip() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterRip([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/rip

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterRipng() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterRipng([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/ripng

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterRouteMap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterRouteMap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/route-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterStatic() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterStatic([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/static

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllRouterStatic6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllRouterStatic6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/static6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSshFilterProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSshFilterProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ssh-filter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchcontrollerAutoconfigDefault() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchcontrollerAutoconfigDefault([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.auto-config/default

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerGlobal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerGlobal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchcontrollerInitialconfigTemplate() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchcontrollerInitialconfigTemplate([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.initial-config/template

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchcontrollerInitialconfigVlans() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchcontrollerInitialconfigVlans([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.initial-config/vlans

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerLldpProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerLldpProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/lldp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerLldpSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerLldpSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/lldp-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerLocation() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerLocation([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/location

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerMacPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerMacPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/mac-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerManagedSwitch() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerManagedSwitch([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/managed-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerNacDevice() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerNacDevice([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/nac-device

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerNacSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerNacSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/nac-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerPortPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerPortPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/port-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchcontrollerSecuritypolicy8021x() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchcontrollerSecuritypolicy8021x([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.security-policy/802-1X

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerSnmpCommunity() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerSnmpCommunity([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/snmp-community

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerStpInstance() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerStpInstance([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/stp-instance

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerStpSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerStpSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/stp-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerSwitchGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerSwitchGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/switch-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerSystem() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerSystem([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/system

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSwitchControllerVlanPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSwitchControllerVlanPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/vlan-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystem3gmodemCustom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystem3gmodemCustom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.3g-modem/custom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAccprofile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAccprofile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/accprofile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAdmin() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAdmin([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAlarm() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAlarm([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/alarm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemApiUser() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemApiUser([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/api-user

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemArpTable() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemArpTable([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/arp-table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutoInstall() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutoInstall([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/auto-install

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutomationAction() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutomationAction([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-action

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutomationDestination() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutomationDestination([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-destination

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutomationStitch() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutomationStitch([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-stitch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutomationTrigger() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutomationTrigger([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-trigger

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutoScript() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutoScript([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/auto-script

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutoupdatePushUpdate() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutoupdatePushUpdate([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.autoupdate/push-update

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutoupdateSchedule() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutoupdateSchedule([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.autoupdate/schedule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemAutoupdateTunneling() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemAutoupdateTunneling([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.autoupdate/tunneling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemCentralManagement() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemCentralManagement([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/central-management

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemClusterSync() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemClusterSync([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/cluster-sync

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemConsole() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemConsole([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/console

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemCsf() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemCsf([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/csf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemCustomLanguage() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemCustomLanguage([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/custom-language

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDdns() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDdns([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ddns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDedicatedMgmt() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDedicatedMgmt([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dedicated-mgmt

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDhcp6Server() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDhcp6Server([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.dhcp6/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDhcpServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDhcpServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.dhcp/server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDns() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDns([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDnsDatabase() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDnsDatabase([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dns-database

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDnsServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDnsServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dns-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemDscpBasedPriority() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemDscpBasedPriority([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dscp-based-priority

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemEmailServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemEmailServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/email-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemExternalResource() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemExternalResource([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/external-resource

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFipsCc() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFipsCc([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/fips-cc

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFortiguard() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFortiguard([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/fortiguard

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFortimanager() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFortimanager([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/fortimanager

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFortisandbox() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFortisandbox([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/fortisandbox

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFssoPolling() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFssoPolling([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/fsso-polling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemFtmPush() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemFtmPush([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ftm-push

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemGeneve() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemGeneve([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geneve

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemGeoipCountry() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemGeoipCountry([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geoip-country

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemGeoipOverride() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemGeoipOverride([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geoip-override

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemGlobal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemGlobal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemGreTunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemGreTunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/gre-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemHa() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemHa([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ha

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemHaMonitor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemHaMonitor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ha-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemInterface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemInterface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpipTunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpipTunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipip-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIps() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIps([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ips

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpsecAggregate() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpsecAggregate([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipsec-aggregate

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpsUrlfilterDns() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpsUrlfilterDns([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ips-urlfilter-dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpsUrlfilterDns6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpsUrlfilterDns6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ips-urlfilter-dns6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpv6NeighborCache() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpv6NeighborCache([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipv6-neighbor-cache

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemIpv6Tunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemIpv6Tunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipv6-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemLinkMonitor() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemLinkMonitor([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/link-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemLldpNetworkPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemLldpNetworkPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.lldp/network-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemLteModem() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemLteModem([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/lte-modem

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemMacAddressTable() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemMacAddressTable([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/mac-address-table

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemMobileTunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemMobileTunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/mobile-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemModem() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemModem([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/modem

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNat64() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNat64([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/nat64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNdProxy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNdProxy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/nd-proxy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNetflow() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNetflow([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/netflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNetworkVisibility() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNetworkVisibility([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/network-visibility

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNpu() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNpu([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/npu

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemNtp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemNtp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ntp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemObjectTagging() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemObjectTagging([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/object-tagging

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemPasswordPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemPasswordPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/password-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemPasswordPolicyGuestAdmin() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemPasswordPolicyGuestAdmin([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/password-policy-guest-admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemPhysicalSwitch() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemPhysicalSwitch([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/physical-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemPppoeInterface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemPppoeInterface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/pppoe-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemProbeResponse() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemProbeResponse([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/probe-response

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemProxyArp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemProxyArp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/proxy-arp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemPtp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemPtp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ptp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgAdmin() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgAdmin([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgAlertmail() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgAlertmail([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/alertmail

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgAuth() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgAuth([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/auth

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgFortiguardWf() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgFortiguardWf([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/fortiguard-wf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgFtp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgFtp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/ftp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/replacemsg-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgHttp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgHttp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/http

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgIcap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgIcap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/icap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgImage() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgImage([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/replacemsg-image

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgMail() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgMail([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/mail

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgNacQuar() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgNacQuar([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/nac-quar

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgSpam() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgSpam([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/spam

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgSslvpn() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgSslvpn([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/sslvpn

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgTrafficQuota() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgTrafficQuota([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/traffic-quota

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgUtm() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgUtm([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/utm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemReplacemsgWebproxy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemReplacemsgWebproxy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/webproxy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemResourceLimits() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemResourceLimits([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/resource-limits

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSaml() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSaml([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/saml

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSdnConnector() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSdnConnector([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sdn-connector

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSdwan() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSdwan([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sdwan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSessionHelper() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSessionHelper([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/session-helper

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSessionTtl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSessionTtl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/session-ttl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSflow() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSflow([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSitTunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSitTunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sit-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSmsServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSmsServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sms-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSnmpCommunity() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSnmpCommunity([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.snmp/community

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSnmpSysinfo() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSnmpSysinfo([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.snmp/sysinfo

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSnmpUser() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSnmpUser([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.snmp/user

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSpeedTestServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSpeedTestServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/speed-test-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSsoAdmin() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSsoAdmin([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sso-admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemStandaloneCluster() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemStandaloneCluster([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/standalone-cluster

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemStorage() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemStorage([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/storage

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemStp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemStp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/stp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemSwitchInterface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemSwitchInterface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/switch-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemTosBasedPriority() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemTosBasedPriority([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/tos-based-priority

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdom() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdom([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomDns() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomDns([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomException() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomException([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-exception

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomLink() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomLink([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-link

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomNetflow() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomNetflow([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-netflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomProperty() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomProperty([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-property

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomRadiusServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomRadiusServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-radius-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVdomSflow() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVdomSflow([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-sflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVirtualSwitch() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVirtualSwitch([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/virtual-switch

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVirtualWirePair() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVirtualWirePair([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/virtual-wire-pair

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVneTunnel() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVneTunnel([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vne-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemVxlan() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemVxlan([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vxlan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemWccp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemWccp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/wccp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllSystemZone() - -

- - -

Select all entries in a CLI table.

- - - public - getAllSystemZone([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/zone

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserAdgrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserAdgrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/adgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserDomainController() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserDomainController([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/domain-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserExchange() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserExchange([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/exchange

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserFortitoken() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserFortitoken([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fortitoken

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserFsso() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserFsso([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fsso

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserFssoPolling() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserFssoPolling([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fsso-polling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserKrbKeytab() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserKrbKeytab([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/krb-keytab

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserLdap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserLdap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/ldap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserLocal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserLocal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserNacPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserNacPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/nac-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserPasswordPolicy() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserPasswordPolicy([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/password-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserPeer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserPeer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/peer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserPeergrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserPeergrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/peergrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserPop3() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserPop3([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/pop3

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserQuarantine() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserQuarantine([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/quarantine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserRadius() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserRadius([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/radius

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserSaml() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserSaml([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/saml

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserSecurityExemptList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserSecurityExemptList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/security-exempt-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllUserTacacs() - -

- - -

Select all entries in a CLI table.

- - - public - getAllUserTacacs([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/tacacs+

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVoipProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVoipProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /voip/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateCa() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateCa([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/ca

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateCrl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateCrl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/crl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateLocal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateLocal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/local

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateOcspServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateOcspServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/ocsp-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateRemote() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateRemote([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/remote

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnCertificateSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnCertificateSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecConcentrator() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecConcentrator([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/concentrator

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecForticlient() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecForticlient([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/forticlient

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecManualkey() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecManualkey([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/manualkey

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecManualkeyInterface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecManualkeyInterface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/manualkey-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecPhase1() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecPhase1([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase1

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecPhase1Interface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecPhase1Interface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase1-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecPhase2() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecPhase2([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase2

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnIpsecPhase2Interface() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnIpsecPhase2Interface([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase2-interface

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnL2tp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnL2tp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn/l2tp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnOcvpn() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnOcvpn([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn/ocvpn

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnPptp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnPptp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn/pptp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslWebHostCheckSoftware() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslWebHostCheckSoftware([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/host-check-software

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslWebPortal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslWebPortal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/portal

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslWebRealm() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslWebRealm([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/realm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslWebUserBookmark() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslWebUserBookmark([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/user-bookmark

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllVpnSslWebUserGroupBookmark() - -

- - -

Select all entries in a CLI table.

- - - public - getAllVpnSslWebUserGroupBookmark([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/user-group-bookmark

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWafMainClass() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWafMainClass([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/main-class

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWafProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWafProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWafSignature() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWafSignature([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/signature

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptAuthGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptAuthGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/auth-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptCacheService() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptCacheService([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/cache-service

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptContentDeliveryNetworkRule() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptContentDeliveryNetworkRule([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/content-delivery-network-rule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptPeer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptPeer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/peer

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptRemoteStorage() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptRemoteStorage([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/remote-storage

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptSettings() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptSettings([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWanoptWebcache() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWanoptWebcache([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/webcache

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterContent() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterContent([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/content

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterContentHeader() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterContentHeader([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/content-header

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterFortiguard() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterFortiguard([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/fortiguard

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterFtgdLocalCat() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterFtgdLocalCat([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ftgd-local-cat

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterFtgdLocalRating() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterFtgdLocalRating([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ftgd-local-rating

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterIpsUrlfilterCacheSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterIpsUrlfilterCacheSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ips-urlfilter-cache-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterIpsUrlfilterSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterIpsUrlfilterSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ips-urlfilter-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterIpsUrlfilterSetting6() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterIpsUrlfilterSetting6([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ips-urlfilter-setting6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterOverride() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterOverride([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/override

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterSearchEngine() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterSearchEngine([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/search-engine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebfilterUrlfilter() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebfilterUrlfilter([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/urlfilter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyDebugUrl() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyDebugUrl([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/debug-url

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyExplicit() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyExplicit([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/explicit

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyForwardServer() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyForwardServer([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/forward-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyForwardServerGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyForwardServerGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/forward-server-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyGlobal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyGlobal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyUrlMatch() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyUrlMatch([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/url-match

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWebProxyWisp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWebProxyWisp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/wisp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerAccessControlList() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerAccessControlList([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/access-control-list

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerAddress() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerAddress([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/address

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerAddrgrp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerAddrgrp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/addrgrp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerApcfgProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerApcfgProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/apcfg-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerApStatus() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerApStatus([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/ap-status

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerArrpProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerArrpProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/arrp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerBleProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerBleProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/ble-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerBonjourProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerBonjourProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/bonjour-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerGlobal() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerGlobal([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20Anqp3gppCellular() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20Anqp3gppCellular([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-3gpp-cellular

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20AnqpIpAddressType() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20AnqpIpAddressType([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-ip-address-type

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20AnqpNaiRealm() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20AnqpNaiRealm([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-nai-realm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20AnqpNetworkAuthType() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20AnqpNetworkAuthType([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-network-auth-type

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20AnqpRoamingConsortium() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20AnqpRoamingConsortium([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-roaming-consortium

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20AnqpVenueName() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20AnqpVenueName([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-venue-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20H2qpConnCapability() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20H2qpConnCapability([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-conn-capability

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20H2qpOperatorName() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20H2qpOperatorName([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-operator-name

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20H2qpOsuProvider() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20H2qpOsuProvider([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-osu-provider

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20H2qpWanMetric() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20H2qpWanMetric([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-wan-metric

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20HsProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20HsProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/hs-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20Icon() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20Icon([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/icon

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelesscontrollerHotspot20QosMap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelesscontrollerHotspot20QosMap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/qos-map

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerInterController() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerInterController([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/inter-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerLog() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerLog([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/log

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerMpskProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerMpskProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/mpsk-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerQosProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerQosProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/qos-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerRegion() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerRegion([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/region

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerSetting() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerSetting([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerSnmp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerSnmp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/snmp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerTimers() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerTimers([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/timers

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerUtmProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerUtmProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/utm-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerVap() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerVap([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/vap

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerVapGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerVapGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/vap-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerWagProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerWagProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wag-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerWidsProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerWidsProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wids-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerWtp() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerWtp([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerWtpGroup() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerWtpGroup([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp-group

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAllWirelessControllerWtpProfile() - -

- - -

Select all entries in a CLI table.

- - - public - getAllWirelessControllerWtpProfile([ $datasource = null ][,  $start = null ][,  $count = null ][,  $with_meta = null ][,  $with_contents_hash = null ][,  $skip = null ][,  $format = null ][,  $filter = null ][,  $key = null ][,  $pattern = null ][,  $scope = null ][,  $excludeDefaultValues = null ][,  $action = null ][,  $vdom = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $start - : - = null
-
-

Starting entry index.

-
- -
-
- $count - : - = null
-
-

Maximum number of entries to return.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $with_contents_hash - : - = null
-
-

Enable to include a checksum of each object's contents.

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $filter - : - = null
-
-

Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR | Separate filters using commas ',' -Logical AND | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

-
- -
-
- $key - : - = null
-
-

If present, objects will be filtered on property with this name.

-
- -
-
- $pattern - : - = null
-
-

If present, objects will be filtered on property with this value.

-
- -
-
- $scope - : - = null
-
-

Scope [global|vdom|both*]

-
- -
-
- $excludeDefaultValues - : - = null
-
-

Exclude properties/objects with default value

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for entire CLI tree. -meta: Return meta data for a specific object, table, or the entire CLI tree. -schema: Return schema for entire CLI tree.

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp-profile

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAntivirusProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getAntivirusProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /antivirus/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getApplicationCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getApplicationCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $tag) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $tag - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getApplicationGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getApplicationGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getApplicationList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getApplicationList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getApplicationName() - -

- - -

Select a specific entry from a CLI table.

- - - public - getApplicationName([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getApplicationRuleSettings() - -

- - -

Select a specific entry from a CLI table.

- - - public - getApplicationRuleSettings([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /application/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAuthenticationRule() - -

- - -

Select a specific entry from a CLI table.

- - - public - getAuthenticationRule([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /authentication/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getAuthenticationScheme() - -

- - -

Select a specific entry from a CLI table.

- - - public - getAuthenticationScheme([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /authentication/scheme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getCertificateCa() - -

- - -

Select a specific entry from a CLI table.

- - - public - getCertificateCa([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getCertificateCrl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getCertificateCrl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getCertificateLocal() - -

- - -

Select a specific entry from a CLI table.

- - - public - getCertificateLocal([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getCertificateRemote() - -

- - -

Select a specific entry from a CLI table.

- - - public - getCertificateRemote([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getCredentialStoreDomainController() - -

- - -

Select a specific entry from a CLI table.

- - - public - getCredentialStoreDomainController([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $serverName) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $serverName - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /credential-store/domain-controller/{server-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDlpFilepattern() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDlpFilepattern([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/filepattern/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDlpFpDocSource() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDlpFpDocSource([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/fp-doc-source/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDlpSensitivity() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDlpSensitivity([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/sensitivity/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDlpSensor() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDlpSensor([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dlp/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDnsfilterDomainFilter() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDnsfilterDomainFilter([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dnsfilter/domain-filter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getDnsfilterProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getDnsfilterProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /dnsfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterBwl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterBwl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/bwl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterBword() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterBword([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/bword/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterDnsbl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterDnsbl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/dnsbl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterIptrust() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterIptrust([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/iptrust/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterMheader() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterMheader([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/mheader/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEmailfilterProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEmailfilterProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /emailfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getEndpointControlFctems() - -

- - -

Select a specific entry from a CLI table.

- - - public - getEndpointControlFctems([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /endpoint-control/fctems/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getExtenderControllerDataplan() - -

- - -

Select a specific entry from a CLI table.

- - - public - getExtenderControllerDataplan([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /extender-controller/dataplan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getExtenderControllerExtender() - -

- - -

Select a specific entry from a CLI table.

- - - public - getExtenderControllerExtender([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /extender-controller/extender/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFileFilterProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFileFilterProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /file-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAcl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAcl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/acl/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAcl6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAcl6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/acl6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAddress() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAddress([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAddress6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAddress6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAddress6Template() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAddress6Template([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/address6-template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAddrgrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAddrgrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallAddrgrp6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallAddrgrp6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/addrgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallCentralSnatMap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallCentralSnatMap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/central-snat-map/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallCity() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallCity([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/city/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallCountry() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallCountry([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallDecryptedTrafficMirror() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallDecryptedTrafficMirror([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/decrypted-traffic-mirror/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallDnstranslation() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallDnstranslation([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/dnstranslation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallDosPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallDosPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/DoS-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallDosPolicy6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallDosPolicy6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/DoS-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallIdentityBasedRoute() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallIdentityBasedRoute([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/identity-based-route/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInterfacePolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInterfacePolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/interface-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInterfacePolicy6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInterfacePolicy6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/interface-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetService() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetService([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceAddition() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceAddition([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-addition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceBotnet() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceBotnet([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-botnet/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceCustomGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceCustomGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-custom-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceDefinition() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceDefinition([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-definition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceExtension() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceExtension([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-extension/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceIpblReason() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceIpblReason([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-ipbl-reason/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceIpblVendor() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceIpblVendor([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-ipbl-vendor/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-list/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceName() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceName([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceOwner() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceOwner([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-owner/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceReputation() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceReputation([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-reputation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallInternetServiceSld() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallInternetServiceSld([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/internet-service-sld/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallIpmacbindingTable() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallIpmacbindingTable([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $seqNum) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ipmacbinding/table/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallIppool() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallIppool([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ippool/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallIppool6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallIppool6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ippool6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallIpTranslation() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallIpTranslation([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $transid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $transid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ip-translation/{transid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallLdbMonitor() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallLdbMonitor([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ldb-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallLocalInPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallLocalInPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/local-in-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallLocalInPolicy6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallLocalInPolicy6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/local-in-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallMulticastAddress() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallMulticastAddress([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallMulticastAddress6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallMulticastAddress6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallMulticastPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallMulticastPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallMulticastPolicy6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallMulticastPolicy6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/multicast-policy6/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallPolicy46() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallPolicy46([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy46/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallPolicy64() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallPolicy64([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/policy64/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallProfileGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallProfileGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/profile-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallProfileProtocolOptions() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallProfileProtocolOptions([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/profile-protocol-options/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallProxyAddress() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallProxyAddress([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallProxyAddrgrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallProxyAddrgrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallProxyPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallProxyPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/proxy-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallRegion() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallRegion([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/region/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallScheduleGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallScheduleGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallScheduleOnetime() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallScheduleOnetime([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/onetime/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallScheduleRecurring() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallScheduleRecurring([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.schedule/recurring/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSecurityPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSecurityPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/security-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallServiceCategory() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallServiceCategory([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/category/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallServiceCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallServiceCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallServiceGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallServiceGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.service/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallShaperPerIpShaper() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallShaperPerIpShaper([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.shaper/per-ip-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallShaperTrafficShaper() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallShaperTrafficShaper([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.shaper/traffic-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallShapingPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallShapingPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/shaping-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallShapingProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallShapingProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $profileName) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $profileName - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/shaping-profile/{profile-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSniffer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSniffer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/sniffer/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSshHostKey() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSshHostKey([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/host-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSshLocalCa() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSshLocalCa([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/local-ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSshLocalKey() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSshLocalKey([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.ssh/local-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSslServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSslServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ssl-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallSslSshProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallSslSshProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ssl-ssh-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallTrafficClass() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallTrafficClass([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $classId) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $classId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/traffic-class/{class-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallTtlPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallTtlPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/ttl-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVendorMac() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVendorMac([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vendor-mac/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVip() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVip([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVip46() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVip46([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVip6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVip6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVip64() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVip64([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vip64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVipgrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVipgrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVipgrp46() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVipgrp46([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVipgrp6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVipgrp6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallVipgrp64() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallVipgrp64([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall/vipgrp64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallWildcardfqdnCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallWildcardfqdnCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.wildcard-fqdn/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getFirewallWildcardfqdnGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getFirewallWildcardfqdnGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /firewall.wildcard-fqdn/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIcapProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIcapProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /icap/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIcapServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIcapServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /icap/server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $tag) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $tag - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsDecoder() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsDecoder([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/decoder/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsRule() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsRule([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsRuleSettings() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsRuleSettings([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsSensor() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsSensor([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getIpsViewMap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getIpsViewMap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ips/view-map/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getLogCustomField() - -

- - -

Select a specific entry from a CLI table.

- - - public - getLogCustomField([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /log/custom-field/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getReportChart() - -

- - -

Select a specific entry from a CLI table.

- - - public - getReportChart([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/chart/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getReportDataset() - -

- - -

Select a specific entry from a CLI table.

- - - public - getReportDataset([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/dataset/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getReportLayout() - -

- - -

Select a specific entry from a CLI table.

- - - public - getReportLayout([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/layout/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getReportStyle() - -

- - -

Select a specific entry from a CLI table.

- - - public - getReportStyle([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/style/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getReportTheme() - -

- - -

Select a specific entry from a CLI table.

- - - public - getReportTheme([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /report/theme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterAccessList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterAccessList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/access-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterAccessList6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterAccessList6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/access-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterAspathList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterAspathList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/aspath-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterAuthPath() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterAuthPath([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/auth-path/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterCommunityList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterCommunityList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/community-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterKeyChain() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterKeyChain([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/key-chain/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterMulticastFlow() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterMulticastFlow([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/multicast-flow/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/policy/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterPolicy6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterPolicy6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/policy6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterPrefixList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterPrefixList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/prefix-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterPrefixList6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterPrefixList6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/prefix-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterRouteMap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterRouteMap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/route-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterStatic() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterStatic([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/static/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getRouterStatic6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getRouterStatic6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /router/static6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSshFilterProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSshFilterProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /ssh-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchcontrollerInitialconfigTemplate() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchcontrollerInitialconfigTemplate([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.initial-config/template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerLldpProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerLldpProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/lldp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerLocation() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerLocation([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/location/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerMacPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerMacPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/mac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerManagedSwitch() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerManagedSwitch([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $switchId) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $switchId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/managed-switch/{switch-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerNacDevice() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerNacDevice([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/nac-device/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerNacSettings() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerNacSettings([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/nac-settings/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerPortPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerPortPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/port-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchcontrollerSecuritypolicy8021x() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchcontrollerSecuritypolicy8021x([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller.security-policy/802-1X/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerSnmpCommunity() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerSnmpCommunity([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/snmp-community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerStpInstance() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerStpInstance([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/stp-instance/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerSwitchGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerSwitchGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/switch-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSwitchControllerVlanPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSwitchControllerVlanPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /switch-controller/vlan-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystem3gmodemCustom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystem3gmodemCustom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.3g-modem/custom/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAccprofile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAccprofile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/accprofile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAdmin() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAdmin([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemApiUser() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemApiUser([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/api-user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemArpTable() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemArpTable([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/arp-table/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAutomationAction() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAutomationAction([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-action/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAutomationDestination() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAutomationDestination([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-destination/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAutomationStitch() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAutomationStitch([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-stitch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAutomationTrigger() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAutomationTrigger([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/automation-trigger/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemAutoScript() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemAutoScript([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/auto-script/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemClusterSync() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemClusterSync([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $syncId) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $syncId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/cluster-sync/{sync-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemCustomLanguage() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemCustomLanguage([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/custom-language/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDdns() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDdns([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $ddnsid) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $ddnsid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ddns/{ddnsid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDhcp6Server() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDhcp6Server([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.dhcp6/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDhcpServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDhcpServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.dhcp/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDnsDatabase() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDnsDatabase([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dns-database/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDnsServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDnsServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dns-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemDscpBasedPriority() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemDscpBasedPriority([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/dscp-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemExternalResource() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemExternalResource([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/external-resource/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemGeneve() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemGeneve([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geneve/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemGeoipCountry() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemGeoipCountry([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geoip-country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemGeoipOverride() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemGeoipOverride([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/geoip-override/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemGreTunnel() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemGreTunnel([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/gre-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemInterface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemInterface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpipTunnel() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpipTunnel([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipip-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpsecAggregate() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpsecAggregate([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipsec-aggregate/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpsUrlfilterDns() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpsUrlfilterDns([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $address) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $address - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ips-urlfilter-dns/{address}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpsUrlfilterDns6() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpsUrlfilterDns6([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $address6) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $address6 - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ips-urlfilter-dns6/{address6}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpv6NeighborCache() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpv6NeighborCache([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipv6-neighbor-cache/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemIpv6Tunnel() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemIpv6Tunnel([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/ipv6-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemLinkMonitor() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemLinkMonitor([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/link-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemLldpNetworkPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemLldpNetworkPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.lldp/network-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemMacAddressTable() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemMacAddressTable([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $mac) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $mac - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/mac-address-table/{mac}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemMobileTunnel() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemMobileTunnel([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/mobile-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemObjectTagging() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemObjectTagging([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $category) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $category - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/object-tagging/{category}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemPhysicalSwitch() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemPhysicalSwitch([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/physical-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemPppoeInterface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemPppoeInterface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/pppoe-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemProxyArp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemProxyArp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/proxy-arp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgAdmin() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgAdmin([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/admin/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgAlertmail() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgAlertmail([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/alertmail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgAuth() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgAuth([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/auth/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgFortiguardWf() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgFortiguardWf([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/fortiguard-wf/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgFtp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgFtp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/ftp/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/replacemsg-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgHttp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgHttp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/http/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgIcap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgIcap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/icap/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgImage() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgImage([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/replacemsg-image/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgMail() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgMail([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/mail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgNacQuar() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgNacQuar([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/nac-quar/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgSpam() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgSpam([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/spam/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgSslvpn() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgSslvpn([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/sslvpn/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgTrafficQuota() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgTrafficQuota([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/traffic-quota/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgUtm() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgUtm([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/utm/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemReplacemsgWebproxy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemReplacemsgWebproxy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.replacemsg/webproxy/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSdnConnector() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSdnConnector([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sdn-connector/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSessionHelper() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSessionHelper([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/session-helper/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSitTunnel() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSitTunnel([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sit-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSmsServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSmsServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sms-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSnmpCommunity() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSnmpCommunity([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.snmp/community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSnmpUser() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSnmpUser([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system.snmp/user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSpeedTestServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSpeedTestServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/speed-test-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSsoAdmin() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSsoAdmin([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/sso-admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemStorage() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemStorage([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/storage/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemSwitchInterface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemSwitchInterface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/switch-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemTosBasedPriority() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemTosBasedPriority([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/tos-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVdom() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVdom([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVdomException() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVdomException([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-exception/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVdomLink() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVdomLink([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-link/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVdomProperty() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVdomProperty([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-property/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVdomRadiusServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVdomRadiusServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vdom-radius-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVirtualSwitch() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVirtualSwitch([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/virtual-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVirtualWirePair() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVirtualWirePair([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/virtual-wire-pair/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemVxlan() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemVxlan([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/vxlan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemWccp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemWccp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $serviceId) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $serviceId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/wccp/{service-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getSystemZone() - -

- - -

Select a specific entry from a CLI table.

- - - public - getSystemZone([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /system/zone/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserAdgrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserAdgrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/adgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserDomainController() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserDomainController([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/domain-controller/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserExchange() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserExchange([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/exchange/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserFortitoken() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserFortitoken([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $serialNumber) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $serialNumber - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fortitoken/{serial-number}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserFsso() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserFsso([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fsso/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserFssoPolling() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserFssoPolling([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/fsso-polling/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserKrbKeytab() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserKrbKeytab([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/krb-keytab/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserLdap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserLdap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/ldap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserLocal() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserLocal([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserNacPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserNacPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/nac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserPasswordPolicy() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserPasswordPolicy([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/password-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserPeer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserPeer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/peer/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserPeergrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserPeergrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/peergrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserPop3() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserPop3([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/pop3/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserRadius() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserRadius([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/radius/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserSaml() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserSaml([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/saml/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserSecurityExemptList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserSecurityExemptList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/security-exempt-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getUserTacacs() - -

- - -

Select a specific entry from a CLI table.

- - - public - getUserTacacs([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /user/tacacs+/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVoipProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVoipProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /voip/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnCertificateCa() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnCertificateCa([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnCertificateCrl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnCertificateCrl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnCertificateLocal() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnCertificateLocal([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnCertificateOcspServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnCertificateOcspServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/ocsp-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnCertificateRemote() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnCertificateRemote([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecConcentrator() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecConcentrator([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/concentrator/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecForticlient() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecForticlient([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $realm) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $realm - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/forticlient/{realm}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecManualkey() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecManualkey([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/manualkey/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecManualkeyInterface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecManualkeyInterface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/manualkey-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecPhase1() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecPhase1([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase1/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecPhase1Interface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecPhase1Interface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase1-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecPhase2() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecPhase2([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase2/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnIpsecPhase2Interface() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnIpsecPhase2Interface([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ipsec/phase2-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnSslWebHostCheckSoftware() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnSslWebHostCheckSoftware([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/host-check-software/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnSslWebPortal() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnSslWebPortal([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/portal/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnSslWebRealm() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnSslWebRealm([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $urlPath) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $urlPath - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/realm/{url-path}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnSslWebUserBookmark() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnSslWebUserBookmark([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/user-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getVpnSslWebUserGroupBookmark() - -

- - -

Select a specific entry from a CLI table.

- - - public - getVpnSslWebUserGroupBookmark([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /vpn.ssl.web/user-group-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWafMainClass() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWafMainClass([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/main-class/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWafProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWafProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWafSignature() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWafSignature([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /waf/signature/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWanoptAuthGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWanoptAuthGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/auth-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWanoptContentDeliveryNetworkRule() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWanoptContentDeliveryNetworkRule([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/content-delivery-network-rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWanoptPeer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWanoptPeer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $peerHostId) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $peerHostId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/peer/{peer-host-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWanoptProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWanoptProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wanopt/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterContent() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterContent([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/content/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterContentHeader() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterContentHeader([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/content-header/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterFtgdLocalCat() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterFtgdLocalCat([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $desc) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $desc - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ftgd-local-cat/{desc}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterFtgdLocalRating() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterFtgdLocalRating([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $url) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $url - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/ftgd-local-rating/{url}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterOverride() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterOverride([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/override/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterSearchEngine() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterSearchEngine([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/search-engine/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebfilterUrlfilter() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebfilterUrlfilter([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /webfilter/urlfilter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyDebugUrl() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyDebugUrl([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/debug-url/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyForwardServer() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyForwardServer([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/forward-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyForwardServerGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyForwardServerGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/forward-server-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyUrlMatch() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyUrlMatch([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/url-match/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWebProxyWisp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWebProxyWisp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /web-proxy/wisp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerAccessControlList() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerAccessControlList([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/access-control-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerAddress() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerAddress([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/address/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerAddrgrp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerAddrgrp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/addrgrp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerApcfgProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerApcfgProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/apcfg-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerApStatus() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerApStatus([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/ap-status/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerArrpProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerArrpProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/arrp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerBleProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerBleProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/ble-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerBonjourProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerBonjourProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/bonjour-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20Anqp3gppCellular() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20Anqp3gppCellular([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-3gpp-cellular/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20AnqpIpAddressType() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20AnqpIpAddressType([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-ip-address-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20AnqpNaiRealm() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20AnqpNaiRealm([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-nai-realm/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20AnqpNetworkAuthType() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20AnqpNetworkAuthType([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-network-auth-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20AnqpRoamingConsortium() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20AnqpRoamingConsortium([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-roaming-consortium/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20AnqpVenueName() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20AnqpVenueName([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/anqp-venue-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20H2qpConnCapability() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20H2qpConnCapability([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-conn-capability/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20H2qpOperatorName() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20H2qpOperatorName([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-operator-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20H2qpOsuProvider() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20H2qpOsuProvider([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-osu-provider/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20H2qpWanMetric() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20H2qpWanMetric([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/h2qp-wan-metric/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20HsProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20HsProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/hs-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20Icon() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20Icon([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/icon/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelesscontrollerHotspot20QosMap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelesscontrollerHotspot20QosMap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller.hotspot20/qos-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerMpskProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerMpskProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/mpsk-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerQosProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerQosProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/qos-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerRegion() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerRegion([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/region/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerUtmProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerUtmProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/utm-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerVap() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerVap([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/vap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerVapGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerVapGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/vap-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerWagProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerWagProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wag-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerWidsProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerWidsProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wids-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerWtp() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerWtp([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $wtpId) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $wtpId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp/{wtp-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerWtpGroup() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerWtpGroup([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- getWirelessControllerWtpProfile() - -

- - -

Select a specific entry from a CLI table.

- - - public - getWirelessControllerWtpProfile([ $datasource = null ][,  $with_meta = null ][,  $skip = null ][,  $format = null ][,  $action = null ][,  $vdom = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $datasource - : - = null
-
-

Enable to include datasource information for each linked object.

-
- -
-
- $with_meta - : - = null
-
-

Enable to include meta information about each object (type id, references, etc).

-
- -
-
- $skip - : - = null
-
-

Enable to call CLI skip operator to hide skipped properties.

-
- -
-
- $format - : - = null
-
-

List of property names to include in results, separated by | (i.e. policyid|srcintf).

-
- -
-
- $action - : - = null
-
-

default: Return the CLI default values for this object type. -schema: Return the CLI schema for this object type. -revision: Return the CMDB revision for this object type. -transaction-list: List all configuration transaction(s).

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

GET /wireless-controller/wtp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- listTransactions() - -

- - -

List all transactions.

- - - public - listTransactions([string $vdom = null ]) : bool - -
- -
Parameters
-
-
- $vdom - : string - = null
-
- -
-
- - - -
Return values
- bool - — -

Return the firewall's response as an object. -As of version 6.4.5, this method sometimes returns unparsable JSON.

-
- - -
-
-

- startTransaction() - -

- - -

Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

- - - public - startTransaction([int $timeout = null ][, string|null $vdom = null ]) : bool - -
- -
Parameters
-
-
- $timeout - : int - = null
-
-

Transaction's timeout.

-
- -
-
- $vdom - : string|null - = null
-
-

Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

-
- -
-
- - - -
Return values
- bool - — -

Return TRUE on success and FALSE on failure.

-
- - -
-
-

- updateAlertemailSetting() - -

- - -

Update this specific resource.

- - - public - updateAlertemailSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /alertemail/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAntivirusHeuristic() - -

- - -

Update this specific resource.

- - - public - updateAntivirusHeuristic( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /antivirus/heuristic

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAntivirusProfile() - -

- - -

Update this specific resource.

- - - public - updateAntivirusProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /antivirus/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAntivirusQuarantine() - -

- - -

Update this specific resource.

- - - public - updateAntivirusQuarantine( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /antivirus/quarantine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAntivirusSettings() - -

- - -

Update this specific resource.

- - - public - updateAntivirusSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /antivirus/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateApplicationCustom() - -

- - -

Update this specific resource.

- - - public - updateApplicationCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $tag) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $tag - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /application/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateApplicationGroup() - -

- - -

Update this specific resource.

- - - public - updateApplicationGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /application/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateApplicationList() - -

- - -

Update this specific resource.

- - - public - updateApplicationList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /application/list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateApplicationName() - -

- - -

Update this specific resource.

- - - public - updateApplicationName( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /application/name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateApplicationRuleSettings() - -

- - -

Update this specific resource.

- - - public - updateApplicationRuleSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /application/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAuthenticationRule() - -

- - -

Update this specific resource.

- - - public - updateAuthenticationRule( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /authentication/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAuthenticationScheme() - -

- - -

Update this specific resource.

- - - public - updateAuthenticationScheme( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /authentication/scheme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateAuthenticationSetting() - -

- - -

Update this specific resource.

- - - public - updateAuthenticationSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /authentication/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateCertificateCa() - -

- - -

Update this specific resource.

- - - public - updateCertificateCa( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateCertificateCrl() - -

- - -

Update this specific resource.

- - - public - updateCertificateCrl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateCertificateLocal() - -

- - -

Update this specific resource.

- - - public - updateCertificateLocal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateCertificateRemote() - -

- - -

Update this specific resource.

- - - public - updateCertificateRemote( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateCredentialStoreDomainController() - -

- - -

Update this specific resource.

- - - public - updateCredentialStoreDomainController( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $serverName) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $serverName - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /credential-store/domain-controller/{server-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDlpFilepattern() - -

- - -

Update this specific resource.

- - - public - updateDlpFilepattern( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dlp/filepattern/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDlpFpDocSource() - -

- - -

Update this specific resource.

- - - public - updateDlpFpDocSource( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dlp/fp-doc-source/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDlpSensitivity() - -

- - -

Update this specific resource.

- - - public - updateDlpSensitivity( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dlp/sensitivity/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDlpSensor() - -

- - -

Update this specific resource.

- - - public - updateDlpSensor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dlp/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDlpSettings() - -

- - -

Update this specific resource.

- - - public - updateDlpSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dlp/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDnsfilterDomainFilter() - -

- - -

Update this specific resource.

- - - public - updateDnsfilterDomainFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dnsfilter/domain-filter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateDnsfilterProfile() - -

- - -

Update this specific resource.

- - - public - updateDnsfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /dnsfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterBwl() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterBwl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/bwl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterBword() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterBword( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/bword/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterDnsbl() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterDnsbl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/dnsbl/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterFortishield() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterFortishield( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/fortishield

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterIptrust() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterIptrust( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/iptrust/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterMheader() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterMheader( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/mheader/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterOptions() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterOptions( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/options

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEmailfilterProfile() - -

- - -

Update this specific resource.

- - - public - updateEmailfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /emailfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateEndpointControlFctems() - -

- - -

Update this specific resource.

- - - public - updateEndpointControlFctems( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /endpoint-control/fctems/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateExtenderControllerDataplan() - -

- - -

Update this specific resource.

- - - public - updateExtenderControllerDataplan( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /extender-controller/dataplan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateExtenderControllerExtender() - -

- - -

Update this specific resource.

- - - public - updateExtenderControllerExtender( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /extender-controller/extender/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFileFilterProfile() - -

- - -

Update this specific resource.

- - - public - updateFileFilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /file-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAcl() - -

- - -

Update this specific resource.

- - - public - updateFirewallAcl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/acl/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAcl6() - -

- - -

Update this specific resource.

- - - public - updateFirewallAcl6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/acl6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAddress() - -

- - -

Update this specific resource.

- - - public - updateFirewallAddress( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAddress6() - -

- - -

Update this specific resource.

- - - public - updateFirewallAddress6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAddress6Template() - -

- - -

Update this specific resource.

- - - public - updateFirewallAddress6Template( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/address6-template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAddrgrp() - -

- - -

Update this specific resource.

- - - public - updateFirewallAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAddrgrp6() - -

- - -

Update this specific resource.

- - - public - updateFirewallAddrgrp6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/addrgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallAuthPortal() - -

- - -

Update this specific resource.

- - - public - updateFirewallAuthPortal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/auth-portal

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallCentralSnatMap() - -

- - -

Update this specific resource.

- - - public - updateFirewallCentralSnatMap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/central-snat-map/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallCity() - -

- - -

Update this specific resource.

- - - public - updateFirewallCity( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/city/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallCountry() - -

- - -

Update this specific resource.

- - - public - updateFirewallCountry( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallDecryptedTrafficMirror() - -

- - -

Update this specific resource.

- - - public - updateFirewallDecryptedTrafficMirror( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/decrypted-traffic-mirror/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallDnstranslation() - -

- - -

Update this specific resource.

- - - public - updateFirewallDnstranslation( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/dnstranslation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallDosPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallDosPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/DoS-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallDosPolicy6() - -

- - -

Update this specific resource.

- - - public - updateFirewallDosPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/DoS-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIdentityBasedRoute() - -

- - -

Update this specific resource.

- - - public - updateFirewallIdentityBasedRoute( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/identity-based-route/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInterfacePolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallInterfacePolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/interface-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInterfacePolicy6() - -

- - -

Update this specific resource.

- - - public - updateFirewallInterfacePolicy6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/interface-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetService() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetService( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceAddition() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceAddition( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-addition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceAppend() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceAppend( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-append

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceBotnet() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceBotnet( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-botnet/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceCustom() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceCustomGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceCustomGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-custom-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceDefinition() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceDefinition( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-definition/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceExtension() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceExtension( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-extension/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceIpblReason() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceIpblReason( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-ipbl-reason/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceIpblVendor() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceIpblVendor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-ipbl-vendor/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceList() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-list/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceName() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceName( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceOwner() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceOwner( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-owner/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceReputation() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceReputation( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-reputation/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallInternetServiceSld() - -

- - -

Update this specific resource.

- - - public - updateFirewallInternetServiceSld( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/internet-service-sld/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIpmacbindingSetting() - -

- - -

Update this specific resource.

- - - public - updateFirewallIpmacbindingSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ipmacbinding/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIpmacbindingTable() - -

- - -

Update this specific resource.

- - - public - updateFirewallIpmacbindingTable( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $seqNum) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ipmacbinding/table/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIppool() - -

- - -

Update this specific resource.

- - - public - updateFirewallIppool( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ippool/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIppool6() - -

- - -

Update this specific resource.

- - - public - updateFirewallIppool6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ippool6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallIpTranslation() - -

- - -

Update this specific resource.

- - - public - updateFirewallIpTranslation( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $transid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $transid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ip-translation/{transid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallLdbMonitor() - -

- - -

Update this specific resource.

- - - public - updateFirewallLdbMonitor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ldb-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallLocalInPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallLocalInPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/local-in-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallLocalInPolicy6() - -

- - -

Update this specific resource.

- - - public - updateFirewallLocalInPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/local-in-policy6/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallMulticastAddress() - -

- - -

Update this specific resource.

- - - public - updateFirewallMulticastAddress( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/multicast-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallMulticastAddress6() - -

- - -

Update this specific resource.

- - - public - updateFirewallMulticastAddress6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/multicast-address6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallMulticastPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallMulticastPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/multicast-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallMulticastPolicy6() - -

- - -

Update this specific resource.

- - - public - updateFirewallMulticastPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/multicast-policy6/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallPolicy46() - -

- - -

Update this specific resource.

- - - public - updateFirewallPolicy46( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/policy46/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallPolicy64() - -

- - -

Update this specific resource.

- - - public - updateFirewallPolicy64( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/policy64/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallProfileGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallProfileGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/profile-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallProfileProtocolOptions() - -

- - -

Update this specific resource.

- - - public - updateFirewallProfileProtocolOptions( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/profile-protocol-options/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallProxyAddress() - -

- - -

Update this specific resource.

- - - public - updateFirewallProxyAddress( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/proxy-address/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallProxyAddrgrp() - -

- - -

Update this specific resource.

- - - public - updateFirewallProxyAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/proxy-addrgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallProxyPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallProxyPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/proxy-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallRegion() - -

- - -

Update this specific resource.

- - - public - updateFirewallRegion( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/region/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallScheduleGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallScheduleGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.schedule/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallScheduleOnetime() - -

- - -

Update this specific resource.

- - - public - updateFirewallScheduleOnetime( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.schedule/onetime/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallScheduleRecurring() - -

- - -

Update this specific resource.

- - - public - updateFirewallScheduleRecurring( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.schedule/recurring/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSecurityPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallSecurityPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $policyid) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $policyid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/security-policy/{policyid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallServiceCategory() - -

- - -

Update this specific resource.

- - - public - updateFirewallServiceCategory( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.service/category/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallServiceCustom() - -

- - -

Update this specific resource.

- - - public - updateFirewallServiceCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.service/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallServiceGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallServiceGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.service/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallShaperPerIpShaper() - -

- - -

Update this specific resource.

- - - public - updateFirewallShaperPerIpShaper( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.shaper/per-ip-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallShaperTrafficShaper() - -

- - -

Update this specific resource.

- - - public - updateFirewallShaperTrafficShaper( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.shaper/traffic-shaper/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallShapingPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallShapingPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/shaping-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallShapingProfile() - -

- - -

Update this specific resource.

- - - public - updateFirewallShapingProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $profileName) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $profileName - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/shaping-profile/{profile-name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSniffer() - -

- - -

Update this specific resource.

- - - public - updateFirewallSniffer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/sniffer/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSshHostKey() - -

- - -

Update this specific resource.

- - - public - updateFirewallSshHostKey( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ssh/host-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSshLocalCa() - -

- - -

Update this specific resource.

- - - public - updateFirewallSshLocalCa( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ssh/local-ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSshLocalKey() - -

- - -

Update this specific resource.

- - - public - updateFirewallSshLocalKey( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ssh/local-key/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSshSetting() - -

- - -

Update this specific resource.

- - - public - updateFirewallSshSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ssh/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSslServer() - -

- - -

Update this specific resource.

- - - public - updateFirewallSslServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ssl-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSslSetting() - -

- - -

Update this specific resource.

- - - public - updateFirewallSslSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.ssl/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallSslSshProfile() - -

- - -

Update this specific resource.

- - - public - updateFirewallSslSshProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ssl-ssh-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallTrafficClass() - -

- - -

Update this specific resource.

- - - public - updateFirewallTrafficClass( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $classId) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $classId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/traffic-class/{class-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallTtlPolicy() - -

- - -

Update this specific resource.

- - - public - updateFirewallTtlPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/ttl-policy/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVendorMac() - -

- - -

Update this specific resource.

- - - public - updateFirewallVendorMac( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vendor-mac/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVendorMacSummary() - -

- - -

Update this specific resource.

- - - public - updateFirewallVendorMacSummary( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vendor-mac-summary

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVip() - -

- - -

Update this specific resource.

- - - public - updateFirewallVip( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vip/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVip46() - -

- - -

Update this specific resource.

- - - public - updateFirewallVip46( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vip46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVip6() - -

- - -

Update this specific resource.

- - - public - updateFirewallVip6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vip6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVip64() - -

- - -

Update this specific resource.

- - - public - updateFirewallVip64( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vip64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVipgrp() - -

- - -

Update this specific resource.

- - - public - updateFirewallVipgrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vipgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVipgrp46() - -

- - -

Update this specific resource.

- - - public - updateFirewallVipgrp46( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vipgrp46/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVipgrp6() - -

- - -

Update this specific resource.

- - - public - updateFirewallVipgrp6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vipgrp6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallVipgrp64() - -

- - -

Update this specific resource.

- - - public - updateFirewallVipgrp64( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall/vipgrp64/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallWildcardfqdnCustom() - -

- - -

Update this specific resource.

- - - public - updateFirewallWildcardfqdnCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.wildcard-fqdn/custom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFirewallWildcardfqdnGroup() - -

- - -

Update this specific resource.

- - - public - updateFirewallWildcardfqdnGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: fwgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /firewall.wildcard-fqdn/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateFtpProxyExplicit() - -

- - -

Update this specific resource.

- - - public - updateFtpProxyExplicit( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ftp-proxy/explicit

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIcapProfile() - -

- - -

Update this specific resource.

- - - public - updateIcapProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /icap/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIcapServer() - -

- - -

Update this specific resource.

- - - public - updateIcapServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /icap/server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsCustom() - -

- - -

Update this specific resource.

- - - public - updateIpsCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $tag) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $tag - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/custom/{tag}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsDecoder() - -

- - -

Update this specific resource.

- - - public - updateIpsDecoder( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/decoder/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsGlobal() - -

- - -

Update this specific resource.

- - - public - updateIpsGlobal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsRule() - -

- - -

Update this specific resource.

- - - public - updateIpsRule( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsRuleSettings() - -

- - -

Update this specific resource.

- - - public - updateIpsRuleSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/rule-settings/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsSensor() - -

- - -

Update this specific resource.

- - - public - updateIpsSensor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/sensor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsSettings() - -

- - -

Update this specific resource.

- - - public - updateIpsSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateIpsViewMap() - -

- - -

Update this specific resource.

- - - public - updateIpsViewMap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ips/view-map/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogCustomField() - -

- - -

Update this specific resource.

- - - public - updateLogCustomField( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log/custom-field/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogDiskFilter() - -

- - -

Update this specific resource.

- - - public - updateLogDiskFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.disk/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogDiskSetting() - -

- - -

Update this specific resource.

- - - public - updateLogDiskSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.disk/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogEventfilter() - -

- - -

Update this specific resource.

- - - public - updateLogEventfilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log/eventfilter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer2Filter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer2Filter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer2/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer2OverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer2OverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer2/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer2OverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer2OverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer2/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer2Setting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer2Setting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer2/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer3Filter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer3Filter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer3/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer3OverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer3OverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer3/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer3OverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer3OverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer3/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzer3Setting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzer3Setting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer3/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzercloudFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzercloudFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer-cloud/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzercloudOverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzercloudOverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer-cloud/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzercloudOverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzercloudOverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer-cloud/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzercloudSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzercloudSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer-cloud/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzerFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzerFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzerOverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzerOverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzerOverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzerOverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortianalyzerSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortianalyzerSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortianalyzer/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortiguardFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortiguardFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortiguard/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortiguardOverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogFortiguardOverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortiguard/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortiguardOverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortiguardOverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortiguard/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogFortiguardSetting() - -

- - -

Update this specific resource.

- - - public - updateLogFortiguardSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.fortiguard/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogGuiDisplay() - -

- - -

Update this specific resource.

- - - public - updateLogGuiDisplay( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log/gui-display

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogMemoryFilter() - -

- - -

Update this specific resource.

- - - public - updateLogMemoryFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.memory/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogMemoryGlobalSetting() - -

- - -

Update this specific resource.

- - - public - updateLogMemoryGlobalSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.memory/global-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogMemorySetting() - -

- - -

Update this specific resource.

- - - public - updateLogMemorySetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.memory/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogNulldeviceFilter() - -

- - -

Update this specific resource.

- - - public - updateLogNulldeviceFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.null-device/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogNulldeviceSetting() - -

- - -

Update this specific resource.

- - - public - updateLogNulldeviceSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.null-device/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd2Filter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd2Filter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd2/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd2OverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd2OverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd2/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd2OverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd2OverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd2/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd2Setting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd2Setting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd2/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd3Filter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd3Filter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd3/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd3OverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd3OverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd3/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd3OverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd3OverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd3/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd3Setting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd3Setting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd3/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd4Filter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd4Filter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd4/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd4OverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd4OverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd4/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd4OverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd4OverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd4/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogd4Setting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogd4Setting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd4/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogdFilter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogdFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogdOverrideFilter() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogdOverrideFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd/override-filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogdOverrideSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogdOverrideSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd/override-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogSyslogdSetting() - -

- - -

Update this specific resource.

- - - public - updateLogSyslogdSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.syslogd/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogThreatWeight() - -

- - -

Update this specific resource.

- - - public - updateLogThreatWeight( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log/threat-weight

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogWebtrendsFilter() - -

- - -

Update this specific resource.

- - - public - updateLogWebtrendsFilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.webtrends/filter

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateLogWebtrendsSetting() - -

- - -

Update this specific resource.

- - - public - updateLogWebtrendsSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /log.webtrends/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportChart() - -

- - -

Update this specific resource.

- - - public - updateReportChart( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/chart/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportDataset() - -

- - -

Update this specific resource.

- - - public - updateReportDataset( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/dataset/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportLayout() - -

- - -

Update this specific resource.

- - - public - updateReportLayout( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/layout/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportSetting() - -

- - -

Update this specific resource.

- - - public - updateReportSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportStyle() - -

- - -

Update this specific resource.

- - - public - updateReportStyle( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/style/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateReportTheme() - -

- - -

Update this specific resource.

- - - public - updateReportTheme( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /report/theme/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterAccessList() - -

- - -

Update this specific resource.

- - - public - updateRouterAccessList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/access-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterAccessList6() - -

- - -

Update this specific resource.

- - - public - updateRouterAccessList6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/access-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterAspathList() - -

- - -

Update this specific resource.

- - - public - updateRouterAspathList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/aspath-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterAuthPath() - -

- - -

Update this specific resource.

- - - public - updateRouterAuthPath( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/auth-path/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterBfd() - -

- - -

Update this specific resource.

- - - public - updateRouterBfd( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/bfd

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterBfd6() - -

- - -

Update this specific resource.

- - - public - updateRouterBfd6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/bfd6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterBgp() - -

- - -

Update this specific resource.

- - - public - updateRouterBgp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/bgp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterCommunityList() - -

- - -

Update this specific resource.

- - - public - updateRouterCommunityList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/community-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterIsis() - -

- - -

Update this specific resource.

- - - public - updateRouterIsis( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/isis

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterKeyChain() - -

- - -

Update this specific resource.

- - - public - updateRouterKeyChain( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/key-chain/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterMulticast() - -

- - -

Update this specific resource.

- - - public - updateRouterMulticast( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/multicast

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterMulticast6() - -

- - -

Update this specific resource.

- - - public - updateRouterMulticast6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/multicast6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterMulticastFlow() - -

- - -

Update this specific resource.

- - - public - updateRouterMulticastFlow( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/multicast-flow/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterOspf() - -

- - -

Update this specific resource.

- - - public - updateRouterOspf( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/ospf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterOspf6() - -

- - -

Update this specific resource.

- - - public - updateRouterOspf6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/ospf6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterPolicy() - -

- - -

Update this specific resource.

- - - public - updateRouterPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/policy/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterPolicy6() - -

- - -

Update this specific resource.

- - - public - updateRouterPolicy6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/policy6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterPrefixList() - -

- - -

Update this specific resource.

- - - public - updateRouterPrefixList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/prefix-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterPrefixList6() - -

- - -

Update this specific resource.

- - - public - updateRouterPrefixList6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/prefix-list6/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterRip() - -

- - -

Update this specific resource.

- - - public - updateRouterRip( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/rip

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterRipng() - -

- - -

Update this specific resource.

- - - public - updateRouterRipng( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/ripng

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterRouteMap() - -

- - -

Update this specific resource.

- - - public - updateRouterRouteMap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/route-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterSetting() - -

- - -

Update this specific resource.

- - - public - updateRouterSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterStatic() - -

- - -

Update this specific resource.

- - - public - updateRouterStatic( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/static/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateRouterStatic6() - -

- - -

Update this specific resource.

- - - public - updateRouterStatic6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $seqNum) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $seqNum - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /router/static6/{seq-num}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSshFilterProfile() - -

- - -

Update this specific resource.

- - - public - updateSshFilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /ssh-filter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchcontrollerAutoconfigDefault() - -

- - -

Update this specific resource.

- - - public - updateSwitchcontrollerAutoconfigDefault( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller.auto-config/default

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerGlobal() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerGlobal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchcontrollerInitialconfigTemplate() - -

- - -

Update this specific resource.

- - - public - updateSwitchcontrollerInitialconfigTemplate( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller.initial-config/template/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchcontrollerInitialconfigVlans() - -

- - -

Update this specific resource.

- - - public - updateSwitchcontrollerInitialconfigVlans( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller.initial-config/vlans

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerLldpProfile() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerLldpProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/lldp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerLldpSettings() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerLldpSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/lldp-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerLocation() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerLocation( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/location/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerMacPolicy() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerMacPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/mac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerManagedSwitch() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerManagedSwitch( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $switchId) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $switchId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/managed-switch/{switch-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerNacDevice() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerNacDevice( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/nac-device/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerNacSettings() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerNacSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/nac-settings/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerPortPolicy() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerPortPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/port-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchcontrollerSecuritypolicy8021x() - -

- - -

Update this specific resource.

- - - public - updateSwitchcontrollerSecuritypolicy8021x( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller.security-policy/802-1X/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerSnmpCommunity() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerSnmpCommunity( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/snmp-community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerStpInstance() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerStpInstance( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/stp-instance/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerStpSettings() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerStpSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/stp-settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerSwitchGroup() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerSwitchGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/switch-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerSystem() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerSystem( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/system

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSwitchControllerVlanPolicy() - -

- - -

Update this specific resource.

- - - public - updateSwitchControllerVlanPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /switch-controller/vlan-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystem3gmodemCustom() - -

- - -

Update this specific resource.

- - - public - updateSystem3gmodemCustom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.3g-modem/custom/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAccprofile() - -

- - -

Update this specific resource.

- - - public - updateSystemAccprofile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/accprofile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAdmin() - -

- - -

Update this specific resource.

- - - public - updateSystemAdmin( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAlarm() - -

- - -

Update this specific resource.

- - - public - updateSystemAlarm( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/alarm

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemApiUser() - -

- - -

Update this specific resource.

- - - public - updateSystemApiUser( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/api-user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemArpTable() - -

- - -

Update this specific resource.

- - - public - updateSystemArpTable( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/arp-table/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutoInstall() - -

- - -

Update this specific resource.

- - - public - updateSystemAutoInstall( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/auto-install

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutomationAction() - -

- - -

Update this specific resource.

- - - public - updateSystemAutomationAction( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/automation-action/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutomationDestination() - -

- - -

Update this specific resource.

- - - public - updateSystemAutomationDestination( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/automation-destination/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutomationStitch() - -

- - -

Update this specific resource.

- - - public - updateSystemAutomationStitch( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/automation-stitch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutomationTrigger() - -

- - -

Update this specific resource.

- - - public - updateSystemAutomationTrigger( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/automation-trigger/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutoScript() - -

- - -

Update this specific resource.

- - - public - updateSystemAutoScript( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/auto-script/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutoupdatePushUpdate() - -

- - -

Update this specific resource.

- - - public - updateSystemAutoupdatePushUpdate( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.autoupdate/push-update

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutoupdateSchedule() - -

- - -

Update this specific resource.

- - - public - updateSystemAutoupdateSchedule( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.autoupdate/schedule

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemAutoupdateTunneling() - -

- - -

Update this specific resource.

- - - public - updateSystemAutoupdateTunneling( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.autoupdate/tunneling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemCentralManagement() - -

- - -

Update this specific resource.

- - - public - updateSystemCentralManagement( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/central-management

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemClusterSync() - -

- - -

Update this specific resource.

- - - public - updateSystemClusterSync( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $syncId) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $syncId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/cluster-sync/{sync-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemConsole() - -

- - -

Update this specific resource.

- - - public - updateSystemConsole( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/console

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemCsf() - -

- - -

Update this specific resource.

- - - public - updateSystemCsf( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/csf

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemCustomLanguage() - -

- - -

Update this specific resource.

- - - public - updateSystemCustomLanguage( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/custom-language/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDdns() - -

- - -

Update this specific resource.

- - - public - updateSystemDdns( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $ddnsid) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $ddnsid - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ddns/{ddnsid}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDedicatedMgmt() - -

- - -

Update this specific resource.

- - - public - updateSystemDedicatedMgmt( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/dedicated-mgmt

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDhcp6Server() - -

- - -

Update this specific resource.

- - - public - updateSystemDhcp6Server( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.dhcp6/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDhcpServer() - -

- - -

Update this specific resource.

- - - public - updateSystemDhcpServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.dhcp/server/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDns() - -

- - -

Update this specific resource.

- - - public - updateSystemDns( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDnsDatabase() - -

- - -

Update this specific resource.

- - - public - updateSystemDnsDatabase( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/dns-database/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDnsServer() - -

- - -

Update this specific resource.

- - - public - updateSystemDnsServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/dns-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemDscpBasedPriority() - -

- - -

Update this specific resource.

- - - public - updateSystemDscpBasedPriority( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/dscp-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemEmailServer() - -

- - -

Update this specific resource.

- - - public - updateSystemEmailServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/email-server

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemExternalResource() - -

- - -

Update this specific resource.

- - - public - updateSystemExternalResource( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/external-resource/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFipsCc() - -

- - -

Update this specific resource.

- - - public - updateSystemFipsCc( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/fips-cc

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFortiguard() - -

- - -

Update this specific resource.

- - - public - updateSystemFortiguard( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/fortiguard

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFortimanager() - -

- - -

Update this specific resource.

- - - public - updateSystemFortimanager( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/fortimanager

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFortisandbox() - -

- - -

Update this specific resource.

- - - public - updateSystemFortisandbox( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/fortisandbox

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFssoPolling() - -

- - -

Update this specific resource.

- - - public - updateSystemFssoPolling( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/fsso-polling

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemFtmPush() - -

- - -

Update this specific resource.

- - - public - updateSystemFtmPush( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ftm-push

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemGeneve() - -

- - -

Update this specific resource.

- - - public - updateSystemGeneve( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/geneve/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemGeoipCountry() - -

- - -

Update this specific resource.

- - - public - updateSystemGeoipCountry( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/geoip-country/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemGeoipOverride() - -

- - -

Update this specific resource.

- - - public - updateSystemGeoipOverride( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/geoip-override/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemGlobal() - -

- - -

Update this specific resource.

- - - public - updateSystemGlobal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemGreTunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemGreTunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/gre-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemHa() - -

- - -

Update this specific resource.

- - - public - updateSystemHa( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ha

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemHaMonitor() - -

- - -

Update this specific resource.

- - - public - updateSystemHaMonitor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ha-monitor

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemInterface() - -

- - -

Update this specific resource.

- - - public - updateSystemInterface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpipTunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemIpipTunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ipip-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIps() - -

- - -

Update this specific resource.

- - - public - updateSystemIps( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ips

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpsecAggregate() - -

- - -

Update this specific resource.

- - - public - updateSystemIpsecAggregate( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ipsec-aggregate/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpsUrlfilterDns() - -

- - -

Update this specific resource.

- - - public - updateSystemIpsUrlfilterDns( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $address) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $address - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ips-urlfilter-dns/{address}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpsUrlfilterDns6() - -

- - -

Update this specific resource.

- - - public - updateSystemIpsUrlfilterDns6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $address6) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $address6 - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ips-urlfilter-dns6/{address6}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpv6NeighborCache() - -

- - -

Update this specific resource.

- - - public - updateSystemIpv6NeighborCache( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ipv6-neighbor-cache/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemIpv6Tunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemIpv6Tunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ipv6-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemLinkMonitor() - -

- - -

Update this specific resource.

- - - public - updateSystemLinkMonitor( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/link-monitor/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemLldpNetworkPolicy() - -

- - -

Update this specific resource.

- - - public - updateSystemLldpNetworkPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.lldp/network-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemLteModem() - -

- - -

Update this specific resource.

- - - public - updateSystemLteModem( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/lte-modem

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemMacAddressTable() - -

- - -

Update this specific resource.

- - - public - updateSystemMacAddressTable( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $mac) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $mac - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/mac-address-table/{mac}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemMobileTunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemMobileTunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/mobile-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemModem() - -

- - -

Update this specific resource.

- - - public - updateSystemModem( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/modem

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNat64() - -

- - -

Update this specific resource.

- - - public - updateSystemNat64( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/nat64

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNdProxy() - -

- - -

Update this specific resource.

- - - public - updateSystemNdProxy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/nd-proxy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNetflow() - -

- - -

Update this specific resource.

- - - public - updateSystemNetflow( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/netflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNetworkVisibility() - -

- - -

Update this specific resource.

- - - public - updateSystemNetworkVisibility( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: loggrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/network-visibility

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNpu() - -

- - -

Update this specific resource.

- - - public - updateSystemNpu( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/npu

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemNtp() - -

- - -

Update this specific resource.

- - - public - updateSystemNtp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ntp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemObjectTagging() - -

- - -

Update this specific resource.

- - - public - updateSystemObjectTagging( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $category) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $category - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/object-tagging/{category}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemPasswordPolicy() - -

- - -

Update this specific resource.

- - - public - updateSystemPasswordPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/password-policy

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemPasswordPolicyGuestAdmin() - -

- - -

Update this specific resource.

- - - public - updateSystemPasswordPolicyGuestAdmin( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/password-policy-guest-admin

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemPhysicalSwitch() - -

- - -

Update this specific resource.

- - - public - updateSystemPhysicalSwitch( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/physical-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemPppoeInterface() - -

- - -

Update this specific resource.

- - - public - updateSystemPppoeInterface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/pppoe-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemProbeResponse() - -

- - -

Update this specific resource.

- - - public - updateSystemProbeResponse( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/probe-response

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemProxyArp() - -

- - -

Update this specific resource.

- - - public - updateSystemProxyArp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/proxy-arp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemPtp() - -

- - -

Update this specific resource.

- - - public - updateSystemPtp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/ptp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgAdmin() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgAdmin( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/admin/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgAlertmail() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgAlertmail( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/alertmail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgAuth() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgAuth( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/auth/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgFortiguardWf() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgFortiguardWf( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/fortiguard-wf/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgFtp() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgFtp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/ftp/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgGroup() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/replacemsg-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgHttp() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgHttp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/http/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgIcap() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgIcap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/icap/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgImage() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgImage( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/replacemsg-image/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgMail() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgMail( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/mail/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgNacQuar() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgNacQuar( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/nac-quar/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgSpam() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgSpam( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/spam/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgSslvpn() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgSslvpn( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/sslvpn/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgTrafficQuota() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgTrafficQuota( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/traffic-quota/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgUtm() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgUtm( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/utm/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemReplacemsgWebproxy() - -

- - -

Update this specific resource.

- - - public - updateSystemReplacemsgWebproxy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $msgType) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $msgType - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.replacemsg/webproxy/{msg-type}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemResourceLimits() - -

- - -

Update this specific resource.

- - - public - updateSystemResourceLimits( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/resource-limits

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSaml() - -

- - -

Update this specific resource.

- - - public - updateSystemSaml( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/saml

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSdnConnector() - -

- - -

Update this specific resource.

- - - public - updateSystemSdnConnector( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sdn-connector/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSdwan() - -

- - -

Update this specific resource.

- - - public - updateSystemSdwan( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sdwan

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSessionHelper() - -

- - -

Update this specific resource.

- - - public - updateSystemSessionHelper( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/session-helper/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSessionTtl() - -

- - -

Update this specific resource.

- - - public - updateSystemSessionTtl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/session-ttl

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSettings() - -

- - -

Update this specific resource.

- - - public - updateSystemSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSflow() - -

- - -

Update this specific resource.

- - - public - updateSystemSflow( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSitTunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemSitTunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sit-tunnel/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSmsServer() - -

- - -

Update this specific resource.

- - - public - updateSystemSmsServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sms-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSnmpCommunity() - -

- - -

Update this specific resource.

- - - public - updateSystemSnmpCommunity( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.snmp/community/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSnmpSysinfo() - -

- - -

Update this specific resource.

- - - public - updateSystemSnmpSysinfo( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.snmp/sysinfo

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSnmpUser() - -

- - -

Update this specific resource.

- - - public - updateSystemSnmpUser( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system.snmp/user/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSpeedTestServer() - -

- - -

Update this specific resource.

- - - public - updateSystemSpeedTestServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/speed-test-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSsoAdmin() - -

- - -

Update this specific resource.

- - - public - updateSystemSsoAdmin( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/sso-admin/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemStandaloneCluster() - -

- - -

Update this specific resource.

- - - public - updateSystemStandaloneCluster( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/standalone-cluster

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemStorage() - -

- - -

Update this specific resource.

- - - public - updateSystemStorage( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/storage/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemStp() - -

- - -

Update this specific resource.

- - - public - updateSystemStp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/stp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemSwitchInterface() - -

- - -

Update this specific resource.

- - - public - updateSystemSwitchInterface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/switch-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemTosBasedPriority() - -

- - -

Update this specific resource.

- - - public - updateSystemTosBasedPriority( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/tos-based-priority/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdom() - -

- - -

Update this specific resource.

- - - public - updateSystemVdom( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomDns() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomDns( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-dns

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomException() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomException( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-exception/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomLink() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomLink( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-link/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomNetflow() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomNetflow( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-netflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomProperty() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomProperty( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-property/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomRadiusServer() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomRadiusServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-radius-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVdomSflow() - -

- - -

Update this specific resource.

- - - public - updateSystemVdomSflow( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vdom-sflow

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVirtualSwitch() - -

- - -

Update this specific resource.

- - - public - updateSystemVirtualSwitch( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: sysgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/virtual-switch/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVirtualWirePair() - -

- - -

Update this specific resource.

- - - public - updateSystemVirtualWirePair( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/virtual-wire-pair/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVneTunnel() - -

- - -

Update this specific resource.

- - - public - updateSystemVneTunnel( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vne-tunnel

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemVxlan() - -

- - -

Update this specific resource.

- - - public - updateSystemVxlan( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/vxlan/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemWccp() - -

- - -

Update this specific resource.

- - - public - updateSystemWccp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $serviceId) : stdClass - -

Access Group: secfabgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $serviceId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/wccp/{service-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateSystemZone() - -

- - -

Update this specific resource.

- - - public - updateSystemZone( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /system/zone/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserAdgrp() - -

- - -

Update this specific resource.

- - - public - updateUserAdgrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/adgrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserDomainController() - -

- - -

Update this specific resource.

- - - public - updateUserDomainController( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/domain-controller/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserExchange() - -

- - -

Update this specific resource.

- - - public - updateUserExchange( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/exchange/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserFortitoken() - -

- - -

Update this specific resource.

- - - public - updateUserFortitoken( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $serialNumber) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $serialNumber - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/fortitoken/{serial-number}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserFsso() - -

- - -

Update this specific resource.

- - - public - updateUserFsso( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/fsso/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserFssoPolling() - -

- - -

Update this specific resource.

- - - public - updateUserFssoPolling( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/fsso-polling/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserGroup() - -

- - -

Update this specific resource.

- - - public - updateUserGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserKrbKeytab() - -

- - -

Update this specific resource.

- - - public - updateUserKrbKeytab( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/krb-keytab/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserLdap() - -

- - -

Update this specific resource.

- - - public - updateUserLdap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/ldap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserLocal() - -

- - -

Update this specific resource.

- - - public - updateUserLocal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserNacPolicy() - -

- - -

Update this specific resource.

- - - public - updateUserNacPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/nac-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserPasswordPolicy() - -

- - -

Update this specific resource.

- - - public - updateUserPasswordPolicy( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/password-policy/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserPeer() - -

- - -

Update this specific resource.

- - - public - updateUserPeer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/peer/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserPeergrp() - -

- - -

Update this specific resource.

- - - public - updateUserPeergrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/peergrp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserPop3() - -

- - -

Update this specific resource.

- - - public - updateUserPop3( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/pop3/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserQuarantine() - -

- - -

Update this specific resource.

- - - public - updateUserQuarantine( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/quarantine

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserRadius() - -

- - -

Update this specific resource.

- - - public - updateUserRadius( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/radius/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserSaml() - -

- - -

Update this specific resource.

- - - public - updateUserSaml( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/saml/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserSecurityExemptList() - -

- - -

Update this specific resource.

- - - public - updateUserSecurityExemptList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/security-exempt-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserSetting() - -

- - -

Update this specific resource.

- - - public - updateUserSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateUserTacacs() - -

- - -

Update this specific resource.

- - - public - updateUserTacacs( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: authgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /user/tacacs+/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVoipProfile() - -

- - -

Update this specific resource.

- - - public - updateVoipProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /voip/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateCa() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateCa( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/ca/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateCrl() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateCrl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/crl/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateLocal() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateLocal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/local/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateOcspServer() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateOcspServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/ocsp-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateRemote() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateRemote( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/remote/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnCertificateSetting() - -

- - -

Update this specific resource.

- - - public - updateVpnCertificateSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.certificate/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecConcentrator() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecConcentrator( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/concentrator/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecForticlient() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecForticlient( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $realm) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $realm - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/forticlient/{realm}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecManualkey() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecManualkey( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/manualkey/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecManualkeyInterface() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecManualkeyInterface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/manualkey-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecPhase1() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecPhase1( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/phase1/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecPhase1Interface() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecPhase1Interface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/phase1-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecPhase2() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecPhase2( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/phase2/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnIpsecPhase2Interface() - -

- - -

Update this specific resource.

- - - public - updateVpnIpsecPhase2Interface( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ipsec/phase2-interface/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnL2tp() - -

- - -

Update this specific resource.

- - - public - updateVpnL2tp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn/l2tp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnOcvpn() - -

- - -

Update this specific resource.

- - - public - updateVpnOcvpn( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn/ocvpn

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnPptp() - -

- - -

Update this specific resource.

- - - public - updateVpnPptp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn/pptp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslSettings() - -

- - -

Update this specific resource.

- - - public - updateVpnSslSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslWebHostCheckSoftware() - -

- - -

Update this specific resource.

- - - public - updateVpnSslWebHostCheckSoftware( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl.web/host-check-software/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslWebPortal() - -

- - -

Update this specific resource.

- - - public - updateVpnSslWebPortal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl.web/portal/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslWebRealm() - -

- - -

Update this specific resource.

- - - public - updateVpnSslWebRealm( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $urlPath) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $urlPath - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl.web/realm/{url-path}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslWebUserBookmark() - -

- - -

Update this specific resource.

- - - public - updateVpnSslWebUserBookmark( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl.web/user-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateVpnSslWebUserGroupBookmark() - -

- - -

Update this specific resource.

- - - public - updateVpnSslWebUserGroupBookmark( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: vpngrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /vpn.ssl.web/user-group-bookmark/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWafMainClass() - -

- - -

Update this specific resource.

- - - public - updateWafMainClass( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /waf/main-class/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWafProfile() - -

- - -

Update this specific resource.

- - - public - updateWafProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /waf/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWafSignature() - -

- - -

Update this specific resource.

- - - public - updateWafSignature( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /waf/signature/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptAuthGroup() - -

- - -

Update this specific resource.

- - - public - updateWanoptAuthGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/auth-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptCacheService() - -

- - -

Update this specific resource.

- - - public - updateWanoptCacheService( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/cache-service

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptContentDeliveryNetworkRule() - -

- - -

Update this specific resource.

- - - public - updateWanoptContentDeliveryNetworkRule( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/content-delivery-network-rule/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptPeer() - -

- - -

Update this specific resource.

- - - public - updateWanoptPeer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $peerHostId) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $peerHostId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/peer/{peer-host-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptProfile() - -

- - -

Update this specific resource.

- - - public - updateWanoptProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptRemoteStorage() - -

- - -

Update this specific resource.

- - - public - updateWanoptRemoteStorage( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/remote-storage

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptSettings() - -

- - -

Update this specific resource.

- - - public - updateWanoptSettings( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/settings

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWanoptWebcache() - -

- - -

Update this specific resource.

- - - public - updateWanoptWebcache( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wanoptgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wanopt/webcache

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterContent() - -

- - -

Update this specific resource.

- - - public - updateWebfilterContent( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/content/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterContentHeader() - -

- - -

Update this specific resource.

- - - public - updateWebfilterContentHeader( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/content-header/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterFortiguard() - -

- - -

Update this specific resource.

- - - public - updateWebfilterFortiguard( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/fortiguard

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterFtgdLocalCat() - -

- - -

Update this specific resource.

- - - public - updateWebfilterFtgdLocalCat( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $desc) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $desc - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/ftgd-local-cat/{desc}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterFtgdLocalRating() - -

- - -

Update this specific resource.

- - - public - updateWebfilterFtgdLocalRating( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $url) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $url - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/ftgd-local-rating/{url}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterIpsUrlfilterCacheSetting() - -

- - -

Update this specific resource.

- - - public - updateWebfilterIpsUrlfilterCacheSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/ips-urlfilter-cache-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterIpsUrlfilterSetting() - -

- - -

Update this specific resource.

- - - public - updateWebfilterIpsUrlfilterSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/ips-urlfilter-setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterIpsUrlfilterSetting6() - -

- - -

Update this specific resource.

- - - public - updateWebfilterIpsUrlfilterSetting6( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/ips-urlfilter-setting6

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterOverride() - -

- - -

Update this specific resource.

- - - public - updateWebfilterOverride( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/override/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterProfile() - -

- - -

Update this specific resource.

- - - public - updateWebfilterProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterSearchEngine() - -

- - -

Update this specific resource.

- - - public - updateWebfilterSearchEngine( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/search-engine/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebfilterUrlfilter() - -

- - -

Update this specific resource.

- - - public - updateWebfilterUrlfilter( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: utmgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /webfilter/urlfilter/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyDebugUrl() - -

- - -

Update this specific resource.

- - - public - updateWebProxyDebugUrl( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/debug-url/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyExplicit() - -

- - -

Update this specific resource.

- - - public - updateWebProxyExplicit( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/explicit

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyForwardServer() - -

- - -

Update this specific resource.

- - - public - updateWebProxyForwardServer( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/forward-server/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyForwardServerGroup() - -

- - -

Update this specific resource.

- - - public - updateWebProxyForwardServerGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/forward-server-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyGlobal() - -

- - -

Update this specific resource.

- - - public - updateWebProxyGlobal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyProfile() - -

- - -

Update this specific resource.

- - - public - updateWebProxyProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyUrlMatch() - -

- - -

Update this specific resource.

- - - public - updateWebProxyUrlMatch( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/url-match/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWebProxyWisp() - -

- - -

Update this specific resource.

- - - public - updateWebProxyWisp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: netgrp

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /web-proxy/wisp/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerAccessControlList() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerAccessControlList( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/access-control-list/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerAddress() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerAddress( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/address/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerAddrgrp() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerAddrgrp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/addrgrp/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerApcfgProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerApcfgProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/apcfg-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerApStatus() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerApStatus( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $id) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $id - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/ap-status/{id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerArrpProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerArrpProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/arrp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerBleProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerBleProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/ble-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerBonjourProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerBonjourProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/bonjour-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerGlobal() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerGlobal( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/global

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20Anqp3gppCellular() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20Anqp3gppCellular( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-3gpp-cellular/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20AnqpIpAddressType() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20AnqpIpAddressType( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-ip-address-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20AnqpNaiRealm() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20AnqpNaiRealm( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-nai-realm/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20AnqpNetworkAuthType() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20AnqpNetworkAuthType( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-network-auth-type/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20AnqpRoamingConsortium() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20AnqpRoamingConsortium( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-roaming-consortium/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20AnqpVenueName() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20AnqpVenueName( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/anqp-venue-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20H2qpConnCapability() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20H2qpConnCapability( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/h2qp-conn-capability/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20H2qpOperatorName() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20H2qpOperatorName( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/h2qp-operator-name/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20H2qpOsuProvider() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20H2qpOsuProvider( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/h2qp-osu-provider/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20H2qpWanMetric() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20H2qpWanMetric( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/h2qp-wan-metric/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20HsProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20HsProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/hs-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20Icon() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20Icon( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/icon/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelesscontrollerHotspot20QosMap() - -

- - -

Update this specific resource.

- - - public - updateWirelesscontrollerHotspot20QosMap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller.hotspot20/qos-map/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerInterController() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerInterController( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/inter-controller

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerLog() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerLog( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/log

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerMpskProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerMpskProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/mpsk-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerQosProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerQosProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/qos-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerRegion() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerRegion( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/region/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerSetting() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerSetting( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/setting

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerSnmp() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerSnmp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/snmp

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerTimers() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerTimers( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ]) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/timers

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerUtmProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerUtmProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/utm-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerVap() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerVap( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/vap/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerVapGroup() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerVapGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/vap-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerWagProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerWagProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/wag-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerWidsProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerWidsProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/wids-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerWtp() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerWtp( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $wtpId) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $wtpId - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/wtp/{wtp-id}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerWtpGroup() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerWtpGroup( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/wtp-group/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- updateWirelessControllerWtpProfile() - -

- - -

Update this specific resource.

- - - public - updateWirelessControllerWtpProfile( $body[,  $vdom = null ][,  $action = null ][,  $before = null ][,  $after = null ],  $name) : stdClass - -

Access Group: wifi

-
- -
Parameters
-
-
- $body - : -
-
-

Possible parameters to go in the body for the request

-
- -
-
- $vdom - : - = null
-
-

Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. -The URL parameter is one of: -vdom=root (Single VDOM) -vdom=vdom1,vdom2 (Multiple VDOMs) -vdom=* (All VDOMs)

-
- -
-
- $action - : - = null
-
-

If supported, an action can be specified. -move: Move this specific resource. -When action=move is set, one of the extra parameters (before, after) must be provided. -Note: If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned.

-
- -
-
- $before - : - = null
-
-

If action=move, use before to specify the ID of the resource that this resource will be moved before. -For example, to move object 1 to before object 2, use: -action=move&before=2 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $after - : - = null
-
-

If action=move, use after to specify the ID of the resource that this resource will be moved after. -For example, to move object 1 to after object 3, use: -action=move&after=3 -Note: This parameter can only be used when the action parameter is set to move.

-
- -
-
- $name - : -
-
-

mkey

-
- -
-
- - -
- Tags - -
-
-
- route -
-
- -

PUT /wireless-controller/wtp-profile/{name}

-
- -
-
- -
Return values
- stdClass - — -

Return the firewall's response as an object.

-
- - -
-
-

- curlRequest() - -

- - -

Method to request the firewall's API.

- - - protected - curlRequest(string $method, string $endpoint[, int|string $pathData = null ][, stdClass|array<string|int, mixed> $queryData = null ][, stdClass|array<string|int, mixed> $bodyData = null ][, int $timeout = null ]) : stdClass - -
- -
Parameters
-
-
- $method - : string -
-
-

HTTP method (e.g. 'GET', 'POST', 'PUT', 'DELETE' ...).

-
- -
-
- $endpoint - : string -
-
-

API endpoint without the 2 first element ('rest' and API version '/api/vX'), e.g. /cmdb/router/static.

-
- -
-
- $pathData - : int|string - = null
-
-

Data to be passed in the request path (only one).

-
- -
-
- $queryData - : stdClass|array<string|int, mixed> - = null
-
-

Data to be passed in the request query as GET arguments.

-
- -
-
- $bodyData - : stdClass|array<string|int, mixed> - = null
-
-

Data to be passed in the request body as a JSON object.

-
- -
-
- $timeout - : int - = null
-
- -
-
- - - -
Return values
- stdClass - — -

Return firewall's response as a stdClass.

-
- - -
-
-

- httpBuildCustomQuery() - -

- - -

Function used to build a query with params but following fortigate satndards.

- - - private - httpBuildCustomQuery(array<string|int, mixed> $data) : string - -
- -
Parameters
-
-
- $data - : array<string|int, mixed> -
-
-

Array of data.

-
- -
-
- - - -
Return values
- string - — -

Return the data encoded in a string to be passed as an URL.

-
- - -
-
-

- login() - -

- - -

Login in the firewall.

- - - private - login() : bool - -
- - - - -
Return values
- bool - — -

Return TRUE if successful or throw Exception if fails.

-
- - -
-
-

- logout() - -

- - -

Logout from the firewall.

- - - private - logout() : Return - -
- - - - -
Return values
- Return - — -

TRUE if successful, FALSE if it failed.

-
- - -
-
- -
-
-
-
-

Search results

- -
-
-
    -
    -
    -
    -
    -
    - - -
    - - - - diff --git a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPILog.html b/docs/classes/Fortinet-FortiOSAPI-FortiOSAPILog.html deleted file mode 100644 index 5d1687d..0000000 --- a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPILog.html +++ /dev/null @@ -1,5271 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
    -

    Documentation

    - - -
    - -
    - - -
    - -
    -
    - - - - -
    - - -
    -

    - FortiOSAPILog - - - extends FortiOSAPI - - - - -

    - - - -

    FortiOS API Log

    - -
    - - -
    - Tags - -
    -
    -
    - link -
    -
    -

    Fortinet developer ressource center.

    -     - -
    -
    - - - - - - -

    - Table of Contents - -

    - -
    -
    - $config - -  : Config -
    -
    - -
    - $session_key - -  : string -
    -
    - -
    - $transaction - -  : int|null -
    -
    - -
    - $config - -  : Config -
    -
    - -
    - $session_key - -  : string -
    -
    - -
    - $transaction - -  : mixed -
    -
    - -
    - __construct() - -  : mixed -
    -
    Constructor takes care of checking and registering firewall's data and login to the API
    - -
    - __destruct() - -  : mixed -
    -
    Destructor takes care of logout.
    - -
    - abortTransaction() - -  : bool -
    -
    Abort a transaction (rollback operations).
    - -
    - addSearchAbort() - -  : stdClass -
    -
    Abort a running log search session.
    - -
    - commitTransaction() - -  : bool -
    -
    Commit a transaction (apply operations).
    - -
    - getAllDiskVirusArchive() - -  : stdClass -
    -
    Return a description of the quarantined virus file.
    - -
    - getAllFortianalyzerVirusArchive() - -  : stdClass -
    -
    Return a description of the quarantined virus file.
    - -
    - getAllForticloudVirusArchive() - -  : stdClass -
    -
    Return a description of the quarantined virus file.
    - -
    - getAllMemoryVirusArchive() - -  : stdClass -
    -
    Return a description of the quarantined virus file.
    - -
    - getDisk() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getDiskArchive() - -  : stdClass -
    -
    Return a list of archived items for the desired type. :type can be app-ctrl or ips
    - -
    - getDiskArchiveDownload() - -  : stdClass -
    -
    Download an archived file.
    - -
    - getDiskEvent() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getDiskEventRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getDiskRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getDiskTraffic() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getDiskTrafficRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getFortianalyzer() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getFortianalyzerArchive() - -  : stdClass -
    -
    Return a list of archived items for the desired type. :type can be app-ctrl or ips
    - -
    - getFortianalyzerArchiveDownload() - -  : stdClass -
    -
    Download an archived file.
    - -
    - getFortianalyzerEvent() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getFortianalyzerEventRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getFortianalyzerRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getFortianalyzerTraffic() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getFortianalyzerTrafficRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getForticloud() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getForticloudArchive() - -  : stdClass -
    -
    Return a list of archived items for the desired type. :type can be app-ctrl or ips
    - -
    - getForticloudArchiveDownload() - -  : stdClass -
    -
    Download an archived file.
    - -
    - getForticloudEvent() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getForticloudEventRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getForticloudRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getForticloudTraffic() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getForticloudTrafficRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getMemory() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getMemoryArchive() - -  : stdClass -
    -
    Return a list of archived items for the desired type. :type can be app-ctrl or ips
    - -
    - getMemoryArchiveDownload() - -  : stdClass -
    -
    Download an archived file.
    - -
    - getMemoryEvent() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getMemoryEventRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getMemoryRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - getMemoryTraffic() - -  : stdClass -
    -
    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.
    - -
    - getMemoryTrafficRaw() - -  : stdClass -
    -
    Log data for the given log type in raw format.
    - -
    - listTransactions() - -  : bool -
    -
    List all transactions.
    - -
    - startTransaction() - -  : bool -
    -
    Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).
    - -
    - curlRequest() - -  : stdClass -
    -
    Method to request the firewall's API.
    - -
    - httpBuildCustomQuery() - -  : string -
    -
    Function used to build a query with params but following fortigate satndards.
    - -
    - login() - -  : bool -
    -
    Login in the firewall.
    - -
    - logout() - -  : Return -
    -
    Logout from the firewall.
    - -
    - - - - - - -
    -

    - Properties - -

    -
    -

    - $config - - - -

    - - - - - public - Config - $config - - -

    Config object with all needed information.

    -
    - - - -
    -
    -

    - $session_key - - - -

    - - - - - public - string - $session_key - - -

    Authentication token kept in cache.

    -
    - - - -
    -
    -

    - $transaction - - - -

    - - - - - public - int|null - $transaction - - -

    Ongoning transaction ID. -WARNING : When going through the method prepareRequestData(), all upper case letter in function parameter name will be replaced by '-' and ;brought down to lower case. If you modify or add new endpoints replace all '-' in parameter name by the next letter in uppercase.

    -
    - - - -
    - -
    -

    - $session_key - - - -

    - - - - - private - string - $session_key - = '' - - - - -
    -
    -

    - $transaction - - - -

    - - - - - private - mixed - $transaction - - - - - -
    -
    - -
    -

    - Methods - -

    -
    -

    - __construct() - -

    - - -

    Constructor takes care of checking and registering firewall's data and login to the API

    - - - public - __construct(Config $config) : mixed - -
    - -
    Parameters
    -
    -
    - $config - : Config -
    -
    -

    Object containing all necessary configuration.

    -
    - -
    -
    - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - __destruct() - -

    - - -

    Destructor takes care of logout.

    - - - public - __destruct() : mixed - -
    - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - abortTransaction() - -

    - - -

    Abort a transaction (rollback operations).

    - - - public - abortTransaction([string|null $vdom = null ]) : bool - -
    - -
    Parameters
    -
    -
    - $vdom - : string|null - = null
    -
    -

    Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

    -
    - -
    -
    - - - -
    Return values
    - bool - — -

    Return TRUE on success and FALSE on failure.

    -
    - - -
    -
    -

    - addSearchAbort() - -

    - - -

    Abort a running log search session.

    - - - public - addSearchAbort( $session_id) : stdClass - -
    - -
    Parameters
    -
    -
    - $session_id - : -
    -
    -

    Provide the session ID for the request

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    POST /search/abort/{session_id}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - commitTransaction() - -

    - - -

    Commit a transaction (apply operations).

    - - - public - commitTransaction([string|null $vdom = null ]) : bool - -
    - -
    Parameters
    -
    -
    - $vdom - : string|null - = null
    -
    -

    Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

    -
    - -
    -
    - - - -
    Return values
    - bool - — -

    Return TRUE on success and FALSE on failure.

    -
    - - -
    -
    -

    - getAllDiskVirusArchive() - -

    - - -

    Return a description of the quarantined virus file.

    - - - public - getAllDiskVirusArchive([ $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $mkey - : - = null
    -
    -

    checksum column from the virus log.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/virus/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getAllFortianalyzerVirusArchive() - -

    - - -

    Return a description of the quarantined virus file.

    - - - public - getAllFortianalyzerVirusArchive([ $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $mkey - : - = null
    -
    -

    checksum column from the virus log.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/virus/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getAllForticloudVirusArchive() - -

    - - -

    Return a description of the quarantined virus file.

    - - - public - getAllForticloudVirusArchive([ $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $mkey - : - = null
    -
    -

    checksum column from the virus log.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/virus/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getAllMemoryVirusArchive() - -

    - - -

    Return a description of the quarantined virus file.

    - - - public - getAllMemoryVirusArchive([ $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $mkey - : - = null
    -
    -

    checksum column from the virus log.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/virus/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDisk() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getDisk( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/{type}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskArchive() - -

    - - -

    Return a list of archived items for the desired type. :type can be app-ctrl or ips

    - - - public - getDiskArchive( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/{type}/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskArchiveDownload() - -

    - - -

    Download an archived file.

    - - - public - getDiskArchiveDownload( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/{type}/archive-download

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskEvent() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getDiskEvent([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/event/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskEventRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getDiskEventRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/event/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getDiskRaw( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/{type}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskTraffic() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getDiskTraffic([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/traffic/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getDiskTrafficRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getDiskTrafficRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /disk/traffic/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzer() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getFortianalyzer( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/{type}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerArchive() - -

    - - -

    Return a list of archived items for the desired type. :type can be app-ctrl or ips

    - - - public - getFortianalyzerArchive( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/{type}/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerArchiveDownload() - -

    - - -

    Download an archived file.

    - - - public - getFortianalyzerArchiveDownload( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/{type}/archive-download

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerEvent() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getFortianalyzerEvent([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/event/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerEventRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getFortianalyzerEventRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/event/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getFortianalyzerRaw( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/{type}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerTraffic() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getFortianalyzerTraffic([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/traffic/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getFortianalyzerTrafficRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getFortianalyzerTrafficRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /fortianalyzer/traffic/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloud() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getForticloud( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/{type}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudArchive() - -

    - - -

    Return a list of archived items for the desired type. :type can be app-ctrl or ips

    - - - public - getForticloudArchive( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/{type}/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudArchiveDownload() - -

    - - -

    Download an archived file.

    - - - public - getForticloudArchiveDownload( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/{type}/archive-download

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudEvent() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getForticloudEvent([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/event/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudEventRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getForticloudEventRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/event/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getForticloudRaw( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/{type}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudTraffic() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getForticloudTraffic([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/traffic/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getForticloudTrafficRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getForticloudTrafficRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /forticloud/traffic/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemory() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getMemory( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/{type}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryArchive() - -

    - - -

    Return a list of archived items for the desired type. :type can be app-ctrl or ips

    - - - public - getMemoryArchive( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/{type}/archive

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryArchiveDownload() - -

    - - -

    Download an archived file.

    - - - public - getMemoryArchiveDownload( $type[,  $mkey = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $mkey - : - = null
    -
    -

    Archive identifier.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/{type}/archive-download

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryEvent() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getMemoryEvent([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/event/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryEventRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getMemoryEventRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Event log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/event/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getMemoryRaw( $type[,  $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $type - : -
    -
    -

    Type of log that can be retrieved

    -
    - -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/{type}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryTraffic() - -

    - - -

    Log data for the given log type (and subtype). Append '/raw' to retrieve in raw format.

    - - - public - getMemoryTraffic([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ][,  $extra = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $extra - : - = null
    -
    -

    Flag(s) for extra data to be included [reverse_lookup|country_id].

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/traffic/{subtype}

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - getMemoryTrafficRaw() - -

    - - -

    Log data for the given log type in raw format.

    - - - public - getMemoryTrafficRaw([ $start = null ][,  $rows = null ][,  $session_id = null ][,  $serial_no = null ][,  $is_ha_member = null ][,  $filter = null ],  $subtype) : stdClass - -
    - -
    Parameters
    -
    -
    - $start - : - = null
    -
    -

    Row number for the first row to return.

    -
    - -
    -
    - $rows - : - = null
    -
    -

    Number of rows to return.

    -
    - -
    -
    - $session_id - : - = null
    -
    -

    Provide a session_id to continue getting data for that request.

    -
    - -
    -
    - $serial_no - : - = null
    -
    -

    Retrieve log from the specified device.

    -
    - -
    -
    - $is_ha_member - : - = null
    -
    -

    Is the specified device an HA member.

    -
    - -
    -
    - $filter - : - = null
    -
    -

    Filtering multiple key/value pairs -Operator | Description -== | Case insensitive match with pattern. -!= | Does not match with pattern (case insensitive). -=@ | Pattern found in object value (case insensitive). -!@ | Pattern not found in object value (case insensitive). -<= | Value must be less than or equal to pattern. -< | Value must be less than pattern. -.>= | Value must be greater than or equal to pattern. -.> | Value must be greater than pattern. -Logical OR using , | Separate filters using commas ',' -Logical AND using & | Filter strings can be combined to create logical AND queries by including multiple filters in the request. -Combining AND and OR | You can combine AND and OR filters together to create more complex filters.

    -
    - -
    -
    - $subtype - : -
    -
    -

    Select the subtype for the Traffic log category

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - route -
    -
    - -

    GET /memory/traffic/{subtype}/raw

    -
    - -
    -
    - -
    Return values
    - stdClass - — -

    Return the firewall's response as an object.

    -
    - - -
    -
    -

    - listTransactions() - -

    - - -

    List all transactions.

    - - - public - listTransactions([string $vdom = null ]) : bool - -
    - -
    Parameters
    -
    -
    - $vdom - : string - = null
    -
    - -
    -
    - - - -
    Return values
    - bool - — -

    Return the firewall's response as an object. -As of version 6.4.5, this method sometimes returns unparsable JSON.

    -
    - - -
    -
    -

    - startTransaction() - -

    - - -

    Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

    - - - public - startTransaction([int $timeout = null ][, string|null $vdom = null ]) : bool - -
    - -
    Parameters
    -
    -
    - $timeout - : int - = null
    -
    -

    Transaction's timeout.

    -
    - -
    -
    - $vdom - : string|null - = null
    -
    -

    Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

    -
    - -
    -
    - - - -
    Return values
    - bool - — -

    Return TRUE on success and FALSE on failure.

    -
    - - -
    -
    -

    - curlRequest() - -

    - - -

    Method to request the firewall's API.

    - - - protected - curlRequest(string $method, string $endpoint[, int|string $pathData = null ][, stdClass|array<string|int, mixed> $queryData = null ][, stdClass|array<string|int, mixed> $bodyData = null ][, int $timeout = null ]) : stdClass - -
    - -
    Parameters
    -
    -
    - $method - : string -
    -
    -

    HTTP method (e.g. 'GET', 'POST', 'PUT', 'DELETE' ...).

    -
    - -
    -
    - $endpoint - : string -
    -
    -

    API endpoint without the 2 first element ('rest' and API version '/api/vX'), e.g. /cmdb/router/static.

    -
    - -
    -
    - $pathData - : int|string - = null
    -
    -

    Data to be passed in the request path (only one).

    -
    - -
    -
    - $queryData - : stdClass|array<string|int, mixed> - = null
    -
    -

    Data to be passed in the request query as GET arguments.

    -
    - -
    -
    - $bodyData - : stdClass|array<string|int, mixed> - = null
    -
    -

    Data to be passed in the request body as a JSON object.

    -
    - -
    -
    - $timeout - : int - = null
    -
    - -
    -
    - - - -
    Return values
    - stdClass - — -

    Return firewall's response as a stdClass.

    -
    - - -
    -
    -

    - httpBuildCustomQuery() - -

    - - -

    Function used to build a query with params but following fortigate satndards.

    - - - private - httpBuildCustomQuery(array<string|int, mixed> $data) : string - -
    - -
    Parameters
    -
    -
    - $data - : array<string|int, mixed> -
    -
    -

    Array of data.

    -
    - -
    -
    - - - -
    Return values
    - string - — -

    Return the data encoded in a string to be passed as an URL.

    -
    - - -
    -
    -

    - login() - -

    - - -

    Login in the firewall.

    - - - private - login() : bool - -
    - - - - -
    Return values
    - bool - — -

    Return TRUE if successful or throw Exception if fails.

    -
    - - -
    -
    -

    - logout() - -

    - - -

    Logout from the firewall.

    - - - private - logout() : Return - -
    - - - - -
    Return values
    - Return - — -

    TRUE if successful, FALSE if it failed.

    -
    - - -
    -
    - -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      -
      - - -
      - - - - diff --git a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPIMonitor.html b/docs/classes/Fortinet-FortiOSAPI-FortiOSAPIMonitor.html deleted file mode 100644 index 27b26c6..0000000 --- a/docs/classes/Fortinet-FortiOSAPI-FortiOSAPIMonitor.html +++ /dev/null @@ -1,26648 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
      -

      Documentation

      - - -
      - -
      - - -
      - -
      -
      - - - - -
      - - -
      -

      - FortiOSAPIMonitor - - - extends FortiOSAPI - - - - -

      - - - -

      FortiOS API Monitor

      - -
      - - -
      - Tags - -
      -
      -
      - link -
      -
      -

      Fortinet developer ressource center.

      -       - -
      -
      - - - - - - -

      - Table of Contents - -

      - -
      -
      - $config - -  : Config -
      -
      - -
      - $session_key - -  : string -
      -
      - -
      - $transaction - -  : int|null -
      -
      - -
      - $config - -  : Config -
      -
      - -
      - $session_key - -  : string -
      -
      - -
      - $transaction - -  : mixed -
      -
      - -
      - __construct() - -  : mixed -
      -
      Constructor takes care of checking and registering firewall's data and login to the API
      - -
      - __destruct() - -  : mixed -
      -
      Destructor takes care of logout.
      - -
      - abortTransaction() - -  : bool -
      -
      Abort a transaction (rollback operations).
      - -
      - addAzureApplicationListRefresh() - -  : stdClass -
      -
      Update the Azure application list data or get the status of an update.
      - -
      - addEndpointControlEmsVerifyCert() - -  : stdClass -
      -
      Verify EMS server certificate for a specific EMS.
      - -
      - addExtenderControllerExtenderDiagnose() - -  : stdClass -
      -
      Execute diagnotic commands.
      - -
      - addExtenderControllerExtenderReset() - -  : stdClass -
      -
      Reset a specific FortiExtender unit.
      - -
      - addExtenderControllerExtenderUpgrade() - -  : stdClass -
      -
      Upgrade FortiExtender.
      - -
      - addFirewallAcl6Clear_counters() - -  : stdClass -
      -
      Reset counters for one or more IPv6 ACLs by policy ID.
      - -
      - addFirewallAclClear_counters() - -  : stdClass -
      -
      Reset counters for one or more IPv4 ACLs by policy ID.
      - -
      - addFirewallClearpassAddressAdd() - -  : stdClass -
      -
      Add ClearPass address with SPT (System Posture Token) value.
      - -
      - addFirewallClearpassAddressDelete() - -  : stdClass -
      -
      Delete ClearPass address with SPT (System Posture Token) value.
      - -
      - addFirewallPerIpShaperReset() - -  : stdClass -
      -
      Reset statistics for all configured firewall per-IP traffic shapers.
      - -
      - addFirewallPolicyClear_counters() - -  : stdClass -
      -
      Reset traffic statistics for one or more firewall policies by policy ID.
      - -
      - addFirewallPolicyReset() - -  : stdClass -
      -
      Reset traffic statistics for all firewall policies.
      - -
      - addFirewallProxyPolicyClear_counters() - -  : stdClass -
      -
      Reset traffic statistics for one or more explicit proxy policies by policy ID.
      - -
      - addFirewallSecurityPolicyClear_counters() - -  : stdClass -
      -
      Reset traffic statistics for one or more security policies by policy ID.
      - -
      - addFirewallSessionClear_all() - -  : stdClass -
      -
      Immediately clear all active IPv4 and IPv6 sessions and IPS sessions of current VDOM.
      - -
      - addFirewallSessionClose() - -  : stdClass -
      -
      Close a specific firewall session that matches all provided criteria.
      - -
      - addFirewallShaperReset() - -  : stdClass -
      -
      Reset statistics for all configured traffic shapers.
      - -
      - addFortiviewSessionCancel() - -  : stdClass -
      -
      Cancel a FortiView request session.
      - -
      - addGeoipGeoipQuerySelect() - -  : stdClass -
      -
      Retrieve location details for IPs queried against FortiGuard's geoip service.
      - -
      - addLicenseDatabaseUpgrade() - -  : stdClass -
      -
      Upgrade or downgrade UTM engine or signature package (IPS/AntiVirus/Application Control/Industrial database/Security Rating) using uploaded file.
      - -
      - addLogLocalReportDelete() - -  : stdClass -
      -
      Delete a local report.
      - -
      - addLogStatsReset() - -  : stdClass -
      -
      Reset logging statistics for all log devices.
      - -
      - addNsxServiceAdd() - -  : stdClass -
      -
      Add NSX service to connector.
      - -
      - addRegistrationForticareAddLicense() - -  : stdClass -
      -
      Add a FortiCare license.
      - -
      - addRegistrationForticareCreate() - -  : stdClass -
      -
      Create a new FortiCare account.
      - -
      - addRegistrationForticareLogin() - -  : stdClass -
      -
      Login to FortiCare.
      - -
      - addRegistrationForticareTransfer() - -  : stdClass -
      -
      Transfer to a new FortiCare account.
      - -
      - addRegistrationForticloudCreate() - -  : stdClass -
      -
      Create a FortiCloud account.
      - -
      - addRegistrationForticloudLogin() - -  : stdClass -
      -
      Login to FortiCloud.
      - -
      - addRegistrationForticloudLogout() - -  : stdClass -
      -
      Logout from FortiCloud.
      - -
      - addRegistrationForticloudMigrate() - -  : stdClass -
      -
      Migrate standalone FortiGate Cloud account to FortiCloud.
      - -
      - addRegistrationForticloudRegisterDevice() - -  : stdClass -
      -
      Register a device to FortiCloud through FortiGate. Currently FortiSwitch and FortiAP are supported.
      - -
      - addRegistrationVdomAddLicense() - -  : stdClass -
      -
      Add a VDOM license.
      - -
      - addSwitchControllerFswFirmwareDownload() - -  : stdClass -
      -
      Download FortiSwitch firmware from FortiGuard to the FortiGate according to FortiSwitch image ID.
      - -
      - addSwitchControllerFswFirmwarePush() - -  : stdClass -
      -
      Push FortiSwitch firmware to the given device.
      - -
      - addSwitchControllerFswFirmwareUpload() - -  : stdClass -
      -
      Upload FortiSwitch firmware to the management FortiGate and then push to target FortiSwitches.
      - -
      - addSwitchControllerManagedSwitchFactoryReset() - -  : stdClass -
      -
      Send 'Factory Reset' command to a given FortiSwitch.
      - -
      - addSwitchControllerManagedSwitchPoeReset() - -  : stdClass -
      -
      Reset PoE on a given FortiSwitch's port.
      - -
      - addSwitchControllerManagedSwitchRestart() - -  : stdClass -
      -
      Restart a given FortiSwitch.
      - -
      - addSwitchControllerManagedSwitchUpdate() - -  : stdClass -
      -
      Update administrative state for a given FortiSwitch (enable or disable authorization).
      - -
      - addSystemAdminChangeVdomMode() - -  : stdClass -
      -
      Switch between VDOM modes.
      - -
      - addSystemApiUserGenerateKey() - -  : stdClass -
      -
      Generate a new api-key for the specified api-key-auth admin. The old api-key will be replaced. The response contains the only chance to read the new api-key plaintext in the api_key field.
      - -
      - addSystemAutomationStitchTest() - -  : stdClass -
      -
      Triggers an automation stitch for testing purposes.
      - -
      - addSystemAutomationStitchWebhook() - -  : stdClass -
      -
      Triggers an incoming webhook for an automation stitch.
      - -
      - addSystemCertificateReadInfo() - -  : stdClass -
      -
      Get certificate information from a certificate string.
      - -
      - addSystemChangePasswordSelect() - -  : stdClass -
      -
      Save admin and guest-admin passwords.
      - -
      - addSystemComLogDump() - -  : stdClass -
      -
      Dump system com-log to file.
      - -
      - addSystemConfigRestore() - -  : stdClass -
      -
      Restore system configuration from uploaded file or from USB.
      - -
      - addSystemConfigRevisionDelete() - -  : stdClass -
      -
      Deletes one or more system configuration revisions.
      - -
      - addSystemConfigRevisionSave() - -  : stdClass -
      -
      Create a new config revision checkpoint.
      - -
      - addSystemConfigRevisionUpdateComments() - -  : stdClass -
      -
      Updates comments for a system configuration file.
      - -
      - addSystemConfigSave() - -  : stdClass -
      -
      Explicitly save all configuration.
      - -
      - addSystemConfigScriptDelete() - -  : stdClass -
      -
      Delete the history of config scripts.
      - -
      - addSystemConfigScriptRun() - -  : stdClass -
      -
      Run remote config scripts.
      - -
      - addSystemConfigScriptUpload() - -  : stdClass -
      -
      Upload and run a new configuration script file.
      - -
      - addSystemCsfRegisterAppliance() - -  : stdClass -
      -
      Register appliance to Security Fabric.
      - -
      - addSystemDhcp6Revoke() - -  : stdClass -
      -
      Revoke IPv6 DHCP leases.
      - -
      - addSystemDhcpRevoke() - -  : stdClass -
      -
      Revoke IPv4 DHCP leases.
      - -
      - addSystemDisconnectAdminsSelect() - -  : stdClass -
      -
      Disconnects logged in administrators.
      - -
      - addSystemFirmwareUpgrade() - -  : stdClass -
      -
      Upgrade firmware image on this device using uploaded file.
      - -
      - addSystemFortiguardClearStatistics() - -  : stdClass -
      -
      Immediately clear all FortiGuard statistics.
      - -
      - addSystemFortiguardTestAvailability() - -  : stdClass -
      -
      Test availability of FortiGuard services.
      - -
      - addSystemFortiguardUpdate() - -  : stdClass -
      -
      Immediately update status for FortiGuard services.
      - -
      - addSystemFortimanagerBackupAction() - -  : stdClass -
      -
      Import or update from FortiManager objects.
      - -
      - addSystemFortimanagerConfig() - -  : stdClass -
      -
      Configure FortiManager IP. Register FortiManager if 'fortimanager_ip' is provided. Unregister FortiManager if only 'unregister' parameter is specified and set to true.
      - -
      - addSystemFsckStart() - -  : stdClass -
      -
      Set file system check flag so that it will be executed on next device reboot.
      - -
      - addSystemHaPeerDisconnect() - -  : stdClass -
      -
      Update configuration of peer in HA cluster.
      - -
      - addSystemHaPeerUpdate() - -  : stdClass -
      -
      Update configuration of peer in HA cluster.
      - -
      - addSystemInterfaceDhcpRenew() - -  : stdClass -
      -
      Renew DHCP lease of an interface.
      - -
      - addSystemInterfaceSpeedTestTrigger() - -  : stdClass -
      -
      Run a speed-test on the given interface.
      - -
      - addSystemLogdiskFormat() - -  : stdClass -
      -
      Format log disk.
      - -
      - addSystemModemConnect() - -  : stdClass -
      -
      Trigger a connect for the configured modem.
      - -
      - addSystemModemDisconnect() - -  : stdClass -
      -
      Trigger a disconnect for the configured modem.
      - -
      - addSystemModemReset() - -  : stdClass -
      -
      Reset statistics for internal/external configured modem.
      - -
      - addSystemModemUpdate() - -  : stdClass -
      -
      Update supported modem list from FortiGuard.
      - -
      - addSystemOsReboot() - -  : stdClass -
      -
      Immediately reboot this device.
      - -
      - addSystemOsShutdown() - -  : stdClass -
      -
      Immediately shutdown this device.
      - -
      - addSystemPasswordPolicyConformSelect() - -  : stdClass -
      -
      Check whether password conforms to the password policy.
      - -
      - addSystemSdnConnectorUpdate() - -  : stdClass -
      -
      Update an SDN connector's connection status.
      - -
      - addSystemSdnConnectorValidateGcpKey() - -  : stdClass -
      -
      Validate a string representing a private key from GCP in PEM format.
      - -
      - addSystemSecurityRatingTrigger() - -  : stdClass -
      -
      Run a Security Rating report.
      - -
      - addSystemSnifferClear() - -  : stdClass -
      -
      Clear the results of a specified packet capture.
      - -
      - addSystemSnifferRestart() - -  : stdClass -
      -
      Restart specified packet capture.
      - -
      - addSystemSnifferStart() - -  : stdClass -
      -
      Start specified packet capture.
      - -
      - addSystemSnifferStop() - -  : stdClass -
      -
      Stop specified packet capture.
      - -
      - addSystemTimeSet() - -  : stdClass -
      -
      Sets current system time stamp.
      - -
      - addSystemUsbDeviceEject() - -  : stdClass -
      -
      Eject USB drives for safe removal.
      - -
      - addSystemUsbLogStart() - -  : stdClass -
      -
      Start backup of logs from current VDOM to USB drive.
      - -
      - addSystemUsbLogStop() - -  : stdClass -
      -
      Stop backup of logs to USB drive.
      - -
      - addSystemVmlicenseUpload() - -  : stdClass -
      -
      Update VM license using uploaded file. Reboots immediately if successful.
      - -
      - addUserBannedAdd_users() - -  : stdClass -
      -
      Immediately add one or more users to the banned list.
      - -
      - addUserBannedClear_all() - -  : stdClass -
      -
      Immediately clear all banned users.
      - -
      - addUserBannedClear_users() - -  : stdClass -
      -
      Immediately clear a list of specific banned users by IP.
      - -
      - addUserDeviceRemove() - -  : stdClass -
      -
      Remove single or multiple user devices specified by host MAC addresses.
      - -
      - addUserFirewallAuth() - -  : stdClass -
      -
      Trigger authentication for a single firewall user.
      - -
      - addUserFirewallDeauth() - -  : stdClass -
      -
      Deauthenticate single, multiple, or all firewall users.
      - -
      - addUserFortitokenActivate() - -  : stdClass -
      -
      Activate a set of FortiTokens by serial number.
      - -
      - addUserFortitokenImportMobile() - -  : stdClass -
      -
      Import a list of tokens from FortiGuard to the FortiGate unit.
      - -
      - addUserFortitokenImportSeed() - -  : stdClass -
      -
      Import a FortiToken seed file.
      - -
      - addUserFortitokenImportTrial() - -  : stdClass -
      -
      Import trial mobile FortiTokens.
      - -
      - addUserFortitokenProvision() - -  : stdClass -
      -
      Provision a set of FortiTokens by serial number.
      - -
      - addUserFortitokenRefresh() - -  : stdClass -
      -
      Refresh a set of FortiTokens by serial number.
      - -
      - addUserFortitokenSendActivation() - -  : stdClass -
      -
      Send a FortiToken activation code to a user via SMS or Email.
      - -
      - addUserFssoRefreshServer() - -  : stdClass -
      -
      Refresh remote agent group list for all fsso agents.
      - -
      - addUserGuestEmail() - -  : stdClass -
      -
      Sent guest login details via email.
      - -
      - addUserGuestSms() - -  : stdClass -
      -
      Sent guest login details via SMS.
      - -
      - addUserRadiusTestConnect() - -  : stdClass -
      -
      Test the connectivity of the given RADIUS server and, optionally, the validity of a username & password.
      - -
      - addUserTacacsPlusTest() - -  : stdClass -
      -
      Test the connectivity of the given TACACS+ server.
      - -
      - addUtmRatingLookupSelect() - -  : stdClass -
      -
      Lookup FortiGuard rating for a specific URL.
      - -
      - addVpnCertificateCaImport() - -  : stdClass -
      -
      Import CA certificate.
      - -
      - addVpnCertificateCrlImport() - -  : stdClass -
      -
      Import certificate revocation lists (CRL) from file content.
      - -
      - addVpnCertificateCsrGenerate() - -  : stdClass -
      -
      Generate a certificate signing request (CSR) and a private key. The CSR can be retrieved / downloaded from CLI, GUI and REST API.
      - -
      - addVpnCertificateLocalImport() - -  : stdClass -
      -
      Import local certificate.
      - -
      - addVpnCertificateRemoteImport() - -  : stdClass -
      -
      Import remote certificate.
      - -
      - addVpnIkeClear() - -  : stdClass -
      -
      Clear IKE gateways.
      - -
      - addVpnIpsecTunnel_down() - -  : stdClass -
      -
      Bring down a specific IPsec VPN tunnel.
      - -
      - addVpnIpsecTunnel_reset_stats() - -  : stdClass -
      -
      Reset statistics for a specific IPsec VPN tunnel.
      - -
      - addVpnIpsecTunnel_up() - -  : stdClass -
      -
      Bring up a specific IPsec VPN tunnel.
      - -
      - addVpnSslClear_tunnel() - -  : stdClass -
      -
      Remove all active tunnel sessions in current virtual domain.
      - -
      - addVpnSslDelete() - -  : stdClass -
      -
      Terminate the provided SSL-VPN session.
      - -
      - addVpnSslProvisionUser() - -  : stdClass -
      -
      Provision SSL-VPN users with target applications. The provisioning message (email or SMS) is sent with no confirmation of success.
      - -
      - addWanoptHistoryReset() - -  : stdClass -
      -
      Reset WAN opt. statistics.
      - -
      - addWanoptPeer_statsReset() - -  : stdClass -
      -
      Reset WAN opt peer statistics.
      - -
      - addWanoptWebcacheReset() - -  : stdClass -
      -
      Reset webcache statistics.
      - -
      - addWebcacheStatsReset() - -  : stdClass -
      -
      Reset all webcache statistics.
      - -
      - addWebfilterCategoryQuotaReset() - -  : stdClass -
      -
      Reset webfilter quota for user or IP.
      - -
      - addWebfilterOverrideDelete() - -  : stdClass -
      -
      Delete a configured webfilter override.
      - -
      - addWebproxyPacfileUpload() - -  : stdClass -
      -
      Upload webproxy PAC file.
      - -
      - addWebUiCustomLanguageCreate() - -  : stdClass -
      -
      Upload custom language file to this Fortigate.
      - -
      - addWebUiCustomLanguageUpdate() - -  : stdClass -
      -
      Update custom language file to this Fortigate.
      - -
      - addWebUiLanguageImport() - -  : stdClass -
      -
      Import localization language file to this FortiGate.
      - -
      - addWifiClientDisassociate() - -  : stdClass -
      -
      Disassociate a WiFi client from the FortiAP it's currently connected to. The client will need to reassociate with the same FortiAP or another to resume connectivity.
      - -
      - addWifiEuclidReset() - -  : stdClass -
      -
      Reset presence analytics statistics.
      - -
      - addWifiFirmwareDownload() - -  : stdClass -
      -
      Download FortiAP firmware from FortiGuard to the FortiGate according to FortiAP image ID.
      - -
      - addWifiFirmwarePush() - -  : stdClass -
      -
      Push FortiAP firmware to the given device.
      - -
      - addWifiFirmwareUpload() - -  : stdClass -
      -
      Upload FortiAP firmware to the management FortiGate and then push to target FortiAPs.
      - -
      - addWifiManaged_apLedBlink() - -  : stdClass -
      -
      Turn a managed FortiAP's LED blinking on or off.
      - -
      - addWifiManaged_apRestart() - -  : stdClass -
      -
      Restart a given FortiAP.
      - -
      - addWifiManaged_apSet_status() - -  : stdClass -
      -
      Update administrative state for a given FortiAP (enable or disable authorization).
      - -
      - addWifiNetworkConnect() - -  : stdClass -
      -
      When FortiWiFi is in client mode, connect to the specified network, if configured in the 'wifi' interface.
      - -
      - addWifiNetworkScan() - -  : stdClass -
      -
      When FortiWiFi is in client mode, start a scan for local WiFi networks.
      - -
      - addWifiRegionImageUpload() - -  : stdClass -
      -
      Saves a floorplan/region image to an existing region.
      - -
      - addWifiRogue_apClear_all() - -  : stdClass -
      -
      Clear all detected rogue APs.
      - -
      - addWifiRogue_apSet_status() - -  : stdClass -
      -
      Mark detected APs as rogue APs.
      - -
      - addWifiSpectrumKeepAlive() - -  : stdClass -
      -
      Extend duration of an existing spectrum analysis for a specific FortiAP.
      - -
      - addWifiSpectrumStart() - -  : stdClass -
      -
      Start spectrum analysis for a specific FortiAP for a duration of time.
      - -
      - addWifiSpectrumStop() - -  : stdClass -
      -
      Stop spectrum analysis for a specific FortiAP.
      - -
      - addWifiSsidGenerateKeys() - -  : stdClass -
      -
      Generate pre-shared keys for specific multi pre-shared key profile.
      - -
      - addWifiVlanProbeStart() - -  : stdClass -
      -
      Start a VLAN probe.
      - -
      - addWifiVlanProbeStop() - -  : stdClass -
      -
      Stop a VLAN probe.
      - -
      - commitTransaction() - -  : bool -
      -
      Commit a transaction (apply operations).
      - -
      - getAllAzureApplicationList() - -  : stdClass -
      -
      Retrieve a list of Azure applications that can be used for configuring an Azure SDN connector.
      - -
      - getAllEndpointControlAvatarDownload() - -  : stdClass -
      -
      Download an endpoint avatar image.
      - -
      - getAllEndpointControlEmsCertStatus() - -  : stdClass -
      -
      Retrieve authentication status of the EMS server certificate for a specific EMS.
      - -
      - getAllEndpointControlEmsStatus() - -  : stdClass -
      -
      Retrieve EMS connection status for a specific EMS.
      - -
      - getAllEndpointControlEmsStatusSummary() - -  : stdClass -
      -
      Retrieve status summary for all configured EMS.
      - -
      - getAllEndpointControlInstaller() - -  : stdClass -
      -
      List available FortiClient installers.
      - -
      - getAllEndpointControlInstallerDownload() - -  : stdClass -
      -
      Download a FortiClient installer via FortiGuard.
      - -
      - getAllEndpointControlRecordList() - -  : stdClass -
      -
      List endpoint records.
      - -
      - getAllEndpointControlSummary() - -  : stdClass -
      -
      Summary of FortiClient endpoint records.
      - -
      - getAllExtenderControllerExtender() - -  : stdClass -
      -
      Retrieve statistics for specific configured FortiExtender units.
      - -
      - getAllFirewallAcl() - -  : stdClass -
      -
      List counters for all IPv4 ACL.
      - -
      - getAllFirewallAcl6() - -  : stdClass -
      -
      List counters for all IPv6 ACL.
      - -
      - getAllFirewallAddress6Dynamic() - -  : stdClass -
      -
      List of IPv6 Fabric Connector address objects and the IPs they resolve to.
      - -
      - getAllFirewallAddressDynamic() - -  : stdClass -
      -
      List of Fabric Connector address objects and the IPs they resolve to.
      - -
      - getAllFirewallAddressFqdns() - -  : stdClass -
      -
      List of FQDN address objects and the IPs they resolved to.
      - -
      - getAllFirewallAddressFqdns6() - -  : stdClass -
      -
      List of IPv6 FQDN address objects and the IPs they resolved to.
      - -
      - getAllFirewallHealth() - -  : stdClass -
      -
      List configured load balance server health monitors.
      - -
      - getAllFirewallInternetServiceDetails() - -  : stdClass -
      -
      List all details for a given Internet Service ID.
      - -
      - getAllFirewallInternetServiceMatch() - -  : stdClass -
      -
      List internet services that exist at a given IP or Subnet.
      - -
      - getAllFirewallIppool() - -  : stdClass -
      -
      List IPv4 pool statistics.
      - -
      - getAllFirewallIppoolMapping() - -  : stdClass -
      -
      Get the list of IPv4 mappings for the specified IP pool.
      - -
      - getAllFirewallLoadBalance() - -  : stdClass -
      -
      List all firewall load balance servers.
      - -
      - getAllFirewallLocalIn() - -  : stdClass -
      -
      List implicit and explicit local-in firewall policies.
      - -
      - getAllFirewallPerIpShaper() - -  : stdClass -
      -
      List of statistics for configured firewall per-IP traffic shapers.
      - -
      - getAllFirewallPolicy() - -  : stdClass -
      -
      List traffic statistics for firewall policies.
      - -
      - getAllFirewallPolicyLookup() - -  : stdClass -
      -
      Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit.
      - -
      - getAllFirewallProxyPolicy() - -  : stdClass -
      -
      List traffic statistics for all explicit proxy policies.
      - -
      - getAllFirewallSdnConnectorFilters() - -  : stdClass -
      -
      List all available filters for a specified SDN Fabric Connector. Used for Fabric Connector address objects.
      - -
      - getAllFirewallSecurityPolicy() - -  : stdClass -
      -
      List IPS engine statistics for security policies.
      - -
      - getAllFirewallSession() - -  : stdClass -
      -
      List all active firewall sessions (optionally filtered).
      - -
      - getAllFirewallShaper() - -  : stdClass -
      -
      List of statistics for configured firewall shared traffic shapers.
      - -
      - getAllFirewallUuidList() - -  : stdClass -
      -
      Retrieve a list of all UUIDs with their object type and VDOM.
      - -
      - getAllFirewallUuidTypeLookup() - -  : stdClass -
      -
      Retrieve a mapping of UUIDs to their firewall object type for given UUIDs.
      - -
      - getAllFortiguardRedirectPortal() - -  : stdClass -
      -
      Retrieve the FortiGuard redirect portal IP.
      - -
      - getAllFortiguardServiceCommunicationStats() - -  : stdClass -
      -
      Retrieve historical statistics for communication with FortiGuard services.
      - -
      - getAllFortiviewSandboxFileDetails() - -  : stdClass -
      -
      Retrieve FortiSandbox analysis details for a specific file checksum.
      - -
      - getAllFortiviewSandboxFileList() - -  : stdClass -
      -
      Retrieve list of available FortiSandbox analysis files.
      - -
      - getAllFortiviewStatistics() - -  : stdClass -
      -
      Retrieve drill-down and summary data for FortiView (both realtime and historical).
      - -
      - getAllIpsAnomaly() - -  : stdClass -
      -
      Returns IPS anomaly list.
      - -
      - getAllIpsExceedScanRange() - -  : stdClass -
      -
      Returns a list of applications that exceed the scan range from a list of application IDs.
      - -
      - getAllIpsMetadata() - -  : stdClass -
      -
      Returns IPS meta data.
      - -
      - getAllIpsRateBased() - -  : stdClass -
      -
      Returns a list of rate-based signatures in IPS package.
      - -
      - getAllLicenseFortianalyzerStatus() - -  : stdClass -
      -
      Get current license & registration status for the connected FortiAnalyzer.
      - -
      - getAllLicenseForticareOrgList() - -  : stdClass -
      -
      Get FortiCare organization size and industry lists.
      - -
      - getAllLicenseForticareResellers() - -  : stdClass -
      -
      Get current FortiCare resellers for the requested country.
      - -
      - getAllLicenseStatus() - -  : stdClass -
      -
      Get current license & registration status.
      - -
      - getAllLogAvArchiveDownload() - -  : stdClass -
      -
      Download file quarantined by AntiVirus.
      - -
      - getAllLogCurrentDiskUsage() - -  : stdClass -
      -
      Return current used, free and total disk bytes.
      - -
      - getAllLogDeviceState() - -  : stdClass -
      -
      Retrieve information on state of log devices.
      - -
      - getAllLogEvent() - -  : stdClass -
      -
      List all event log descriptions. Deprecated in 6.2.3 replaced by /api/v2/static/logid_metadata.json.
      - -
      - getAllLogFortianalyzer() - -  : stdClass -
      -
      Return FortiAnalyzer/FortiManager log status.
      - -
      - getAllLogFortianalyzerQueue() - -  : stdClass -
      -
      Retrieve information on FortiAnalyzer's queue state. Note:- FortiAnalyzer logs are queued only if upload-option is realtime.
      - -
      - getAllLogForticloud() - -  : stdClass -
      -
      Return FortiCloud log status.
      - -
      - getAllLogForticloudReportDownload() - -  : stdClass -
      -
      Download PDF report from FortiCloud.
      - -
      - getAllLogForticloudReportList() - -  : stdClass -
      -
      Get FortiCloud report list.
      - -
      - getAllLogHistoricDailyRemoteLogs() - -  : stdClass -
      -
      Returns the amount of logs in bytes sent daily to a remote logging service (FortiCloud or FortiAnalyzer).
      - -
      - getAllLogHourlyDiskUsage() - -  : stdClass -
      -
      Return historic hourly disk usage in bytes.
      - -
      - getAllLogIpsArchiveDownload() - -  : stdClass -
      -
      Download IPS/application control packet capture files. Uses configured log display device.
      - -
      - getAllLogLocalReportDownload() - -  : stdClass -
      -
      Download local report -Access Group: loggrp.data-access
      - -
      - getAllLogLocalReportList() - -  : stdClass -
      -
      Get local reports list.
      - -
      - getAllLogPolicyArchiveDownload() - -  : stdClass -
      -
      Download policy-based packet capture archive.
      - -
      - getAllLogStats() - -  : stdClass -
      -
      Return number of logs sent by category per day for a specific log device.
      - -
      - getAllNetworkArp() - -  : stdClass -
      -
      Get IPv4 ARP table.
      - -
      - getAllNetworkDdnsLookup() - -  : stdClass -
      -
      Check DDNS FQDN availability.
      - -
      - getAllNetworkDdnsServers() - -  : stdClass -
      -
      Get DDNS servers.
      - -
      - getAllNetworkDnsLatency() - -  : stdClass -
      -
      Get DNS latency.
      - -
      - getAllNetworkFortiguardLiveServicesLatency() - -  : stdClass -
      -
      Get latency information for live FortiGuard services.
      - -
      - getAllNetworkLldpNeighbors() - -  : stdClass -
      -
      List all active LLDP neighbors.
      - -
      - getAllNetworkLldpPorts() - -  : stdClass -
      -
      List all active LLDP ports.
      - -
      - getAllNetworkReverseIpLookup() - -  : stdClass -
      -
      Retrieve the resolved DNS domain name for a given IP address.
      - -
      - getAllNsxInstance() - -  : stdClass -
      -
      List NSX instances and their resource statistics.
      - -
      - getAllNsxServiceStatus() - -  : stdClass -
      -
      Retrieve NSX service status.
      - -
      - getAllRegistrationForticloudDeviceStatus() - -  : stdClass -
      -
      Fetch device registration status from FortiCloud. Currently FortiSwitch and FortiAP are supported.
      - -
      - getAllRegistrationForticloudDisclaimer() - -  : stdClass -
      -
      Retrieve the FortiCloud disclaimer.
      - -
      - getAllRegistrationForticloudDomains() - -  : stdClass -
      -
      Retrieve a list of FortiCloud login domains.
      - -
      - getAllRouterIpv4() - -  : stdClass -
      -
      List all active IPv4 routing table entries.
      - -
      - getAllRouterIpv6() - -  : stdClass -
      -
      List all active IPv6 routing table entries.
      - -
      - getAllRouterLookup() - -  : stdClass -
      -
      Performs a route lookup by querying the routing table.
      - -
      - getAllRouterLookupPolicy() - -  : stdClass -
      -
      Performs a route lookup by querying the policy routing table.
      - -
      - getAllRouterPolicy() - -  : stdClass -
      -
      Retrieve a list of active IPv4 policy routes.
      - -
      - getAllRouterPolicy6() - -  : stdClass -
      -
      Retrieve a list of active IPv6 policy routes.
      - -
      - getAllRouterStatistics() - -  : stdClass -
      -
      Retrieve routing table statistics, including number of matched routes.
      - -
      - getAllSwitchControllerDetectedDevice() - -  : stdClass -
      -
      Retrieve a list of devices detected on all switches.
      - -
      - getAllSwitchControllerFswFirmware() - -  : stdClass -
      -
      Retrieve a list of recommended firmware for managed FortiSwitches.
      - -
      - getAllSwitchControllerManagedSwitch() - -  : stdClass -
      -
      Retrieve statistics for configured FortiSwitches -Access Group: wifi
      - -
      - getAllSwitchControllerManagedSwitchCableStatus() - -  : stdClass -
      -
      Diagnose cable information for a port. Virtual FortiSwitches and FortiLink ports are not supported.
      - -
      - getAllSwitchControllerManagedSwitchDhcpSnooping() - -  : stdClass -
      -
      Retrieve DHCP servers monitored by FortiSwitches.
      - -
      - getAllSwitchControllerManagedSwitchFaceplateXml() - -  : stdClass -
      -
      Retrieve XML for rendering FortiSwitch faceplate widget.
      - -
      - getAllSwitchControllerManagedSwitchHealth() - -  : stdClass -
      -
      Retrieve health-check statistics for managed FortiSwitches.
      - -
      - getAllSwitchControllerManagedSwitchTransceivers() - -  : stdClass -
      -
      Get a list of transceivers being used by managed FortiSwitches.
      - -
      - getAllSwitchControllerMclagIclEligiblePeer() - -  : stdClass -
      -
      Find a pair of FortiSwitches that are eligible to form a tier-1 MCLAG.
      - -
      - getAllSwitchControllerValidateSwitchPrefix() - -  : stdClass -
      -
      Validate a FortiSwitch serial number prefix.
      - -
      - getAllSystem3gModem() - -  : stdClass -
      -
      List all 3G modems available via FortiGuard.
      - -
      - getAllSystemAcquiredDns() - -  : stdClass -
      -
      Retrieve a list of interfaces and their acquired DNS servers.
      - -
      - getAllSystemAutomationStitchStats() - -  : stdClass -
      -
      Stats for automation stitches.
      - -
      - getAllSystemAvailableCertificates() - -  : stdClass -
      -
      Get available certificates.
      - -
      - getAllSystemAvailableInterfaces() - -  : stdClass -
      -
      Retrieve a list of all interfaces along with some meta information regarding their availability.
      - -
      - getAllSystemBotnet() - -  : stdClass -
      -
      List all known IP-based botnet entries in FortiGuard botnet database.
      - -
      - getAllSystemBotnetDomains() - -  : stdClass -
      -
      List all known domain-based botnet entries in FortiGuard botnet database.
      - -
      - getAllSystemBotnetDomainsHits() - -  : stdClass -
      -
      List hit botnet domains with hit count > 0.
      - -
      - getAllSystemBotnetDomainsStat() - -  : stdClass -
      -
      List statistics on domain-based botnet entries in FortiGuard botnet database.
      - -
      - getAllSystemBotnetStat() - -  : stdClass -
      -
      Retrieve statistics for FortiGuard botnet database.
      - -
      - getAllSystemCertificateDownload() - -  : stdClass -
      -
      Download certificate.
      - -
      - getAllSystemCheckPortAvailability() - -  : stdClass -
      -
      Check whether a list of TCP port ranges is available for a certain service.
      - -
      - getAllSystemComLogDownload() - -  : stdClass -
      -
      Download com-log file (after file dump is complete).
      - -
      - getAllSystemComLogUpdate() - -  : stdClass -
      -
      Fetch system com-log file dump progress.
      - -
      - getAllSystemConfigBackup() - -  : stdClass -
      -
      Backup system config -Access Group: sysgrp.mnt
      - -
      - getAllSystemConfigErrorLogDownload() - -  : stdClass -
      -
      Download the error log of the configuration management database.
      - -
      - getAllSystemConfigRevision() - -  : stdClass -
      -
      Returns a list of system configuration revisions.
      - -
      - getAllSystemConfigRevisionFile() - -  : stdClass -
      -
      Download a specific configuration revision.
      - -
      - getAllSystemConfigRevisionInfo() - -  : stdClass -
      -
      Retrieve meta information for a specific configuration revision.
      - -
      - getAllSystemConfigScript() - -  : stdClass -
      -
      Retrieve the information about config scripts.
      - -
      - getAllSystemConfigSyncStatus() - -  : stdClass -
      -
      Get configuration sync status of SLBC cluster master and slave.
      - -
      - getAllSystemConfigUsbFilelist() - -  : stdClass -
      -
      List configuration files available on connected USB drive.
      - -
      - getAllSystemCsf() - -  : stdClass -
      -
      Retrieve a full tree of downstream FortiGates registered to the Security Fabric.
      - -
      - getAllSystemCsfPendingAuthorizations() - -  : stdClass -
      -
      Retrieve fabric devices with pending authorizations for joining the Security Fabric. Note:- This list is currently available on Security Fabric root only.
      - -
      - getAllSystemCurrentAdmins() - -  : stdClass -
      -
      Return a list of currently logged in administrators.
      - -
      - getAllSystemDebugDownload() - -  : stdClass -
      -
      Download debug report for technical support.
      - -
      - getAllSystemDhcp() - -  : stdClass -
      -
      List all DHCP and DHCPv6 leases.
      - -
      - getAllSystemFirmware() - -  : stdClass -
      -
      Retrieve a list of firmware images available to use for upgrade on this device.
      - -
      - getAllSystemFirmwareUpgradePaths() - -  : stdClass -
      -
      Retrieve a list of supported firmware upgrade paths.
      - -
      - getAllSystemFortiguardServerInfo() - -  : stdClass -
      -
      Get FortiGuard server list and information.
      - -
      - getAllSystemFortimanagerBackupDetails() - -  : stdClass -
      -
      Get the properties of a FortiManager object.
      - -
      - getAllSystemFortimanagerBackupSummary() - -  : stdClass -
      -
      Get FortiManager backup summary.
      - -
      - getAllSystemFortimanagerStatus() - -  : stdClass -
      -
      Get FortiManager status.
      - -
      - getAllSystemGlobalResources() - -  : stdClass -
      -
      Retrieve current usage of global resources as well as both the default and user configured maximum values.
      - -
      - getAllSystemHaChecksums() - -  : stdClass -
      -
      List of checksums for members of HA cluster.
      - -
      - getAllSystemHaHistory() - -  : stdClass -
      -
      Get HA cluster historical logs.
      - -
      - getAllSystemHaPeer() - -  : stdClass -
      -
      Get configuration of peer(s) in HA cluster. Uptime is expressed in seconds.
      - -
      - getAllSystemHaStatistics() - -  : stdClass -
      -
      List of statistics for members of HA cluster.
      - -
      - getAllSystemInterface() - -  : stdClass -
      -
      Retrieve statistics for all system interfaces.
      - -
      - getAllSystemInterfaceConnectedAdminsInfo() - -  : stdClass -
      -
      Return admins info that are connected to current interface.
      - -
      - getAllSystemInterfaceDhcpStatus() - -  : stdClass -
      -
      Retrieve the DHCP client status of an interface.
      - -
      - getAllSystemInterfacePoe() - -  : stdClass -
      -
      Retrieve PoE statistics for system interfaces.
      - -
      - getAllSystemInterfaceSpeedTestStatus() - -  : stdClass -
      -
      Retrieve the current status of a speed-test with the results if finished.
      - -
      - getAllSystemInterfaceTransceivers() - -  : stdClass -
      -
      Get a list of transceivers being used by the FortiGate.
      - -
      - getAllSystemIpconf() - -  : stdClass -
      -
      Determine if there is an IP conflict for a specific IP using ARP.
      - -
      - getAllSystemLinkMonitor() - -  : stdClass -
      -
      Retrieve per-interface statistics for active link monitors.
      - -
      - getAllSystemModem() - -  : stdClass -
      -
      Retrieve statistics for internal/external configured modem.
      - -
      - getAllSystemNat46Ippools() - -  : stdClass -
      -
      Retrieve a list of all IPv6 IP pools that are valid for NAT 46 policies.
      - -
      - getAllSystemNtpStatus() - -  : stdClass -
      -
      List NTP servers status.
      - -
      - getAllSystemObjectUsage() - -  : stdClass -
      -
      Retrieve all objects that are currently using as well as objects that can use the given object.
      - -
      - getAllSystemResolveFqdn() - -  : stdClass -
      -
      Resolves the provided FQDNs to FQDN -> IP mappings.
      - -
      - getAllSystemResourceUsage() - -  : stdClass -
      -
      Retreive current and historical usage data for a provided resource.
      - -
      - getAllSystemRunningProcesses() - -  : stdClass -
      -
      List of running processes and their resource usage.
      - -
      - getAllSystemSandboxCloudRegions() - -  : stdClass -
      -
      Retrieve a list of FortiSandbox cloud regions.
      - -
      - getAllSystemSandboxStats() - -  : stdClass -
      -
      Retrieve sandbox statistics.
      - -
      - getAllSystemSandboxStatus() - -  : stdClass -
      -
      Retrieve sandbox status.
      - -
      - getAllSystemSandboxTestConnect() - -  : stdClass -
      -
      Test the connectivity of a given FortiSandbox IP.
      - -
      - getAllSystemSdnConnectorNsxSecurityTags() - -  : stdClass -
      -
      Retrieve a list of NSX security tags for connected NSX servers.
      - -
      - getAllSystemSdnConnectorStatus() - -  : stdClass -
      -
      Retrieve connection status for SDN connectors.
      - -
      - getAllSystemSecurityRating() - -  : stdClass -
      -
      Retrieve a Security Rating report result. Without ID specified, returns the most recent result.
      - -
      - getAllSystemSecurityRatingHistory() - -  : stdClass -
      -
      Retrieve Security Rating history.
      - -
      - getAllSystemSecurityRatingLang() - -  : stdClass -
      -
      Returns the requested Security Rating language mapping.
      - -
      - getAllSystemSecurityRatingStatus() - -  : stdClass -
      -
      Check if a Security Rating report is currently running.
      - -
      - getAllSystemSecurityRatingSupportedReports() - -  : stdClass -
      -
      Retrieve list of report types the Security Rating package supports.
      - -
      - getAllSystemSensorInfo() - -  : stdClass -
      -
      Retrieve system sensor status.
      - -
      - getAllSystemSniffer() - -  : stdClass -
      -
      Return a list of all configured packet captures.
      - -
      - getAllSystemSnifferDownload() - -  : stdClass -
      -
      Download a stored packet capture.
      - -
      - getAllSystemStatus() - -  : stdClass -
      -
      Retrieve basic system status.
      - -
      - getAllSystemStorage() - -  : stdClass -
      -
      Retrieve information for the non-boot disk.
      - -
      - getAllSystemTime() - -  : stdClass -
      -
      Gets current system time stamp.
      - -
      - getAllSystemTimezone() - -  : stdClass -
      -
      Get world timezone and daylight saving time.
      - -
      - getAllSystemTrustedCertAuthorities() - -  : stdClass -
      -
      Get trusted certifiate authorities.
      - -
      - getAllSystemUsbLog() - -  : stdClass -
      -
      Retrieve information about connected USB drives, including estimated log sizes.
      - -
      - getAllSystemVdomLink() - -  : stdClass -
      -
      Gets a list of all NPU VDOM Links and VDOM Links.
      - -
      - getAllSystemVdomResource() - -  : stdClass -
      -
      Retrieve VDOM resource information, including CPU and memory usage.
      - -
      - getAllSystemVmInformation() - -  : stdClass -
      -
      Get VM information.
      - -
      - getAllUserBanned() - -  : stdClass -
      -
      Return a list of all banned users by IP.
      - -
      - getAllUserCollectedEmail() - -  : stdClass -
      -
      List email addresses collected from captive portal.
      - -
      - getAllUserDetectedDevice() - -  : stdClass -
      -
      Retrieve a list of detected devices.
      - -
      - getAllUserDevice() - -  : stdClass -
      -
      Retrieve a list of detected devices.
      - -
      - getAllUserDeviceQuery() - -  : stdClass -
      -
      Retrieve user devices from user device store. List all the user devices if there is no filter set.
      - -
      - getAllUserFirewall() - -  : stdClass -
      -
      List authenticated firewall users.
      - -
      - getAllUserFortitoken() - -  : stdClass -
      -
      Retrieve a map of FortiTokens and their status.
      - -
      - getAllUserFortitokenCloudStatus() - -  : stdClass -
      -
      Retrieve FortiToken Cloud service status.
      - -
      - getAllUserFsso() - -  : stdClass -
      -
      Get a list of fsso and fsso polling status.
      - -
      - getAllUserInfoQuery() - -  : stdClass -
      -
      Query user info.
      - -
      - getAllUserInfoThumbnail() - -  : stdClass -
      -
      Get user info thumbnail. Returns the first match to the filter.
      - -
      - getAllUtmAntivirusStats() - -  : stdClass -
      -
      Retrieve antivirus scanning statistics.
      - -
      - getAllUtmApplicationCategories() - -  : stdClass -
      -
      Retrieve a list of application control categories.
      - -
      - getAllUtmAppLookup() - -  : stdClass -
      -
      Query remote FortiFlow database to resolve hosts to application control entries.
      - -
      - getAllUtmBlacklistedCertificates() - -  : stdClass -
      -
      Retrieve a list of blacklisted SSL certificates.
      - -
      - getAllUtmBlacklistedCertificatesStatistics() - -  : stdClass -
      -
      Retrieve blacklisted SSL certificates statistics.
      - -
      - getAllVirtualWanHealthCheck() - -  : stdClass -
      -
      Retrieve health-check statistics for each SD-WAN link.
      - -
      - getAllVirtualWanInterfaceLog() - -  : stdClass -
      -
      Retrieve log of SD-WAN interface quality information.
      - -
      - getAllVirtualWanMembers() - -  : stdClass -
      -
      Retrieve interface statistics for each SD-WAN link.
      - -
      - getAllVirtualWanSlaLog() - -  : stdClass -
      -
      Retrieve log of SLA probe results for for each SD-WAN SLA rule.
      - -
      - getAllVpnIpsec() - -  : stdClass -
      -
      Return an array of active IPsec VPNs.
      - -
      - getAllVpnOcvpnMembers() - -  : stdClass -
      -
      Get information on devices registered in the Overlay Controller VPN cloud assisted group.
      - -
      - getAllVpnOcvpnMeta() - -  : stdClass -
      -
      Get meta information (e.g. licenses and registered members) from Overlay Controller VPN cloud service.
      - -
      - getAllVpnOcvpnStatus() - -  : stdClass -
      -
      Get the last status message from FortiCloud Overlay Controller VPN cloud service.
      - -
      - getAllVpnSsl() - -  : stdClass -
      -
      Retrieve a list of all SSL-VPN sessions and sub-sessions.
      - -
      - getAllVpnSslStats() - -  : stdClass -
      -
      Return statistics about the SSL-VPN.
      - -
      - getAllWanoptHistory() - -  : stdClass -
      -
      Retrieve WAN opt. statistics history.
      - -
      - getAllWanoptPeer_stats() - -  : stdClass -
      -
      Retrieve a list of WAN opt peer statistics.
      - -
      - getAllWanoptWebcache() - -  : stdClass -
      -
      Retrieve webcache statistics history.
      - -
      - getAllWebcacheStats() - -  : stdClass -
      -
      Retrieve webcache statistics.
      - -
      - getAllWebfilterCategoryQuota() - -  : stdClass -
      -
      Retrieve quota usage statistics for webfilter categories.
      - -
      - getAllWebfilterFortiguardCategories() - -  : stdClass -
      -
      Return FortiGuard web filter categories.
      - -
      - getAllWebfilterMaliciousUrls() - -  : stdClass -
      -
      List all URLs in FortiSandbox malicious URL database.
      - -
      - getAllWebfilterMaliciousUrlsStat() - -  : stdClass -
      -
      Retrieve statistics for the FortiSandbox malicious URL database.
      - -
      - getAllWebfilterOverride() - -  : stdClass -
      -
      List all administrative and user initiated webfilter overrides.
      - -
      - getAllWebfilterTrustedUrls() - -  : stdClass -
      -
      List all URLs in FortiGuard trusted URL database.
      - -
      - getAllWebproxyPacfileDownload() - -  : stdClass -
      -
      Download webproxy PAC file.
      - -
      - getAllWebUiCustomLanguageDownload() - -  : stdClass -
      -
      Download a custom language file.
      - -
      - getAllWifiAp_status() - -  : stdClass -
      -
      Retrieve statistics for all managed FortiAPs.
      - -
      - getAllWifiClient() - -  : stdClass -
      -
      Retrieve a list of connected WiFi clients.
      - -
      - getAllWifiEuclid() - -  : stdClass -
      -
      Retrieve presence analytics statistics.
      - -
      - getAllWifiFirmware() - -  : stdClass -
      -
      Retrieve a list of current and recommended firmware for FortiAPs in use.
      - -
      - getAllWifiInterfering_ap() - -  : stdClass -
      -
      Retrieve a list of interfering APs for one FortiAP radio.
      - -
      - getAllWifiManaged_ap() - -  : stdClass -
      -
      Retrieve a list of managed FortiAPs.
      - -
      - getAllWifiNetworkList() - -  : stdClass -
      -
      When FortiWiFi is in client mode, retrieve list of local WiFi networks.
      - -
      - getAllWifiNetworkStatus() - -  : stdClass -
      -
      When FortiWiFi is in client mode, retrieve status of currently connected WiFi network, if any.
      - -
      - getAllWifiRegionImage() - -  : stdClass -
      -
      Retrieves a floorplan/region image from a configured FortiAP region.
      - -
      - getAllWifiRogue_ap() - -  : stdClass -
      -
      Retrieve a list of detected rogue APs.
      - -
      - getAllWifiSpectrum() - -  : stdClass -
      -
      Retrieve spectrum analysis information for a specific FortiAP.
      - -
      - getAllWifiVlanProbe() - -  : stdClass -
      -
      Retrieve the VLAN probe results.
      - -
      - listTransactions() - -  : bool -
      -
      List all transactions.
      - -
      - startTransaction() - -  : bool -
      -
      Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).
      - -
      - curlRequest() - -  : stdClass -
      -
      Method to request the firewall's API.
      - -
      - httpBuildCustomQuery() - -  : string -
      -
      Function used to build a query with params but following fortigate satndards.
      - -
      - login() - -  : bool -
      -
      Login in the firewall.
      - -
      - logout() - -  : Return -
      -
      Logout from the firewall.
      - -
      - - - - - - -
      -

      - Properties - -

      -
      -

      - $config - - - -

      - - - - - public - Config - $config - - -

      Config object with all needed information.

      -
      - - - -
      -
      -

      - $session_key - - - -

      - - - - - public - string - $session_key - - -

      Authentication token kept in cache.

      -
      - - - -
      -
      -

      - $transaction - - - -

      - - - - - public - int|null - $transaction - - -

      Ongoning transaction ID. -WARNING : When going through the method prepareRequestData(), all upper case letter in function parameter name will be replaced by '-' and ;brought down to lower case. If you modify or add new endpoints replace all '-' in parameter name by the next letter in uppercase.

      -
      - - - -
      - -
      -

      - $session_key - - - -

      - - - - - private - string - $session_key - = '' - - - - -
      -
      -

      - $transaction - - - -

      - - - - - private - mixed - $transaction - - - - - -
      -
      - -
      -

      - Methods - -

      -
      -

      - __construct() - -

      - - -

      Constructor takes care of checking and registering firewall's data and login to the API

      - - - public - __construct(Config $config) : mixed - -
      - -
      Parameters
      -
      -
      - $config - : Config -
      -
      -

      Object containing all necessary configuration.

      -
      - -
      -
      - - - -
      Return values
      - mixed - — -
      - - -
      -
      -

      - __destruct() - -

      - - -

      Destructor takes care of logout.

      - - - public - __destruct() : mixed - -
      - - - - -
      Return values
      - mixed - — -
      - - -
      -
      -

      - abortTransaction() - -

      - - -

      Abort a transaction (rollback operations).

      - - - public - abortTransaction([string|null $vdom = null ]) : bool - -
      - -
      Parameters
      -
      -
      - $vdom - : string|null - = null
      -
      -

      Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

      -
      - -
      -
      - - - -
      Return values
      - bool - — -

      Return TRUE on success and FALSE on failure.

      -
      - - -
      -
      -

      - addAzureApplicationListRefresh() - -

      - - -

      Update the Azure application list data or get the status of an update.

      - - - public - addAzureApplicationListRefresh( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /azure/application-list/refresh

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addEndpointControlEmsVerifyCert() - -

      - - -

      Verify EMS server certificate for a specific EMS.

      - - - public - addEndpointControlEmsVerifyCert( $body) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /endpoint-control/ems/verify-cert

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addExtenderControllerExtenderDiagnose() - -

      - - -

      Execute diagnotic commands.

      - - - public - addExtenderControllerExtenderDiagnose( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /extender-controller/extender/diagnose

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addExtenderControllerExtenderReset() - -

      - - -

      Reset a specific FortiExtender unit.

      - - - public - addExtenderControllerExtenderReset( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /extender-controller/extender/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addExtenderControllerExtenderUpgrade() - -

      - - -

      Upgrade FortiExtender.

      - - - public - addExtenderControllerExtenderUpgrade( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /extender-controller/extender/upgrade

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallAcl6Clear_counters() - -

      - - -

      Reset counters for one or more IPv6 ACLs by policy ID.

      - - - public - addFirewallAcl6Clear_counters( $body) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/acl6/clear_counters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallAclClear_counters() - -

      - - -

      Reset counters for one or more IPv4 ACLs by policy ID.

      - - - public - addFirewallAclClear_counters( $body) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/acl/clear_counters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallClearpassAddressAdd() - -

      - - -

      Add ClearPass address with SPT (System Posture Token) value.

      - - - public - addFirewallClearpassAddressAdd( $body) : stdClass - -

      Access Group: fwgrp.address

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/clearpass-address/add

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallClearpassAddressDelete() - -

      - - -

      Delete ClearPass address with SPT (System Posture Token) value.

      - - - public - addFirewallClearpassAddressDelete( $body) : stdClass - -

      Access Group: fwgrp.address

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/clearpass-address/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallPerIpShaperReset() - -

      - - -

      Reset statistics for all configured firewall per-IP traffic shapers.

      - - - public - addFirewallPerIpShaperReset() : stdClass - -

      Access Group: fwgrp.others

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/per-ip-shaper/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallPolicyClear_counters() - -

      - - -

      Reset traffic statistics for one or more firewall policies by policy ID.

      - - - public - addFirewallPolicyClear_counters( $body) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/policy/clear_counters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallPolicyReset() - -

      - - -

      Reset traffic statistics for all firewall policies.

      - - - public - addFirewallPolicyReset() : stdClass - -

      Access Group: fwgrp.policy

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/policy/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallProxyPolicyClear_counters() - -

      - - -

      Reset traffic statistics for one or more explicit proxy policies by policy ID.

      - - - public - addFirewallProxyPolicyClear_counters( $body) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/proxy-policy/clear_counters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallSecurityPolicyClear_counters() - -

      - - -

      Reset traffic statistics for one or more security policies by policy ID.

      - - - public - addFirewallSecurityPolicyClear_counters( $body) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/security-policy/clear_counters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallSessionClear_all() - -

      - - -

      Immediately clear all active IPv4 and IPv6 sessions and IPS sessions of current VDOM.

      - - - public - addFirewallSessionClear_all() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/session/clear_all

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallSessionClose() - -

      - - -

      Close a specific firewall session that matches all provided criteria.

      - - - public - addFirewallSessionClose( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/session/close

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFirewallShaperReset() - -

      - - -

      Reset statistics for all configured traffic shapers.

      - - - public - addFirewallShaperReset() : stdClass - -

      Access Group: fwgrp.others

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /firewall/shaper/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addFortiviewSessionCancel() - -

      - - -

      Cancel a FortiView request session.

      - - - public - addFortiviewSessionCancel( $body) : stdClass - -

      Access Group: ftviewgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /fortiview/session/cancel

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addGeoipGeoipQuerySelect() - -

      - - -

      Retrieve location details for IPs queried against FortiGuard's geoip service.

      - - - public - addGeoipGeoipQuerySelect( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /geoip/geoip-query/select

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addLicenseDatabaseUpgrade() - -

      - - -

      Upgrade or downgrade UTM engine or signature package (IPS/AntiVirus/Application Control/Industrial database/Security Rating) using uploaded file.

      - - - public - addLicenseDatabaseUpgrade( $body) : stdClass - -

      Access Group: sysgrp.upd

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /license/database/upgrade

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addLogLocalReportDelete() - -

      - - -

      Delete a local report.

      - - - public - addLogLocalReportDelete( $body) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /log/local-report/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addLogStatsReset() - -

      - - -

      Reset logging statistics for all log devices.

      - - - public - addLogStatsReset() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /log/stats/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addNsxServiceAdd() - -

      - - -

      Add NSX service to connector.

      - - - public - addNsxServiceAdd( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /nsx/service/add

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticareAddLicense() - -

      - - -

      Add a FortiCare license.

      - - - public - addRegistrationForticareAddLicense( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticare/add-license

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticareCreate() - -

      - - -

      Create a new FortiCare account.

      - - - public - addRegistrationForticareCreate( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticare/create

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticareLogin() - -

      - - -

      Login to FortiCare.

      - - - public - addRegistrationForticareLogin( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticare/login

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticareTransfer() - -

      - - -

      Transfer to a new FortiCare account.

      - - - public - addRegistrationForticareTransfer( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticare/transfer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticloudCreate() - -

      - - -

      Create a FortiCloud account.

      - - - public - addRegistrationForticloudCreate( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticloud/create

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticloudLogin() - -

      - - -

      Login to FortiCloud.

      - - - public - addRegistrationForticloudLogin( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticloud/login

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticloudLogout() - -

      - - -

      Logout from FortiCloud.

      - - - public - addRegistrationForticloudLogout() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticloud/logout

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticloudMigrate() - -

      - - -

      Migrate standalone FortiGate Cloud account to FortiCloud.

      - - - public - addRegistrationForticloudMigrate( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticloud/migrate

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationForticloudRegisterDevice() - -

      - - -

      Register a device to FortiCloud through FortiGate. Currently FortiSwitch and FortiAP are supported.

      - - - public - addRegistrationForticloudRegisterDevice( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/forticloud/register-device

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addRegistrationVdomAddLicense() - -

      - - -

      Add a VDOM license.

      - - - public - addRegistrationVdomAddLicense( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /registration/vdom/add-license

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerFswFirmwareDownload() - -

      - - -

      Download FortiSwitch firmware from FortiGuard to the FortiGate according to FortiSwitch image ID.

      - - - public - addSwitchControllerFswFirmwareDownload( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/fsw-firmware/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerFswFirmwarePush() - -

      - - -

      Push FortiSwitch firmware to the given device.

      - - - public - addSwitchControllerFswFirmwarePush( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/fsw-firmware/push

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerFswFirmwareUpload() - -

      - - -

      Upload FortiSwitch firmware to the management FortiGate and then push to target FortiSwitches.

      - - - public - addSwitchControllerFswFirmwareUpload( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/fsw-firmware/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerManagedSwitchFactoryReset() - -

      - - -

      Send 'Factory Reset' command to a given FortiSwitch.

      - - - public - addSwitchControllerManagedSwitchFactoryReset( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/managed-switch/factory-reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerManagedSwitchPoeReset() - -

      - - -

      Reset PoE on a given FortiSwitch's port.

      - - - public - addSwitchControllerManagedSwitchPoeReset( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/managed-switch/poe-reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerManagedSwitchRestart() - -

      - - -

      Restart a given FortiSwitch.

      - - - public - addSwitchControllerManagedSwitchRestart( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/managed-switch/restart

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSwitchControllerManagedSwitchUpdate() - -

      - - -

      Update administrative state for a given FortiSwitch (enable or disable authorization).

      - - - public - addSwitchControllerManagedSwitchUpdate( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /switch-controller/managed-switch/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemAdminChangeVdomMode() - -

      - - -

      Switch between VDOM modes.

      - - - public - addSystemAdminChangeVdomMode( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/admin/change-vdom-mode

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemApiUserGenerateKey() - -

      - - -

      Generate a new api-key for the specified api-key-auth admin. The old api-key will be replaced. The response contains the only chance to read the new api-key plaintext in the api_key field.

      - - - public - addSystemApiUserGenerateKey( $body) : stdClass - -

      Access Group: sysgrp.admin

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/api-user/generate-key

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemAutomationStitchTest() - -

      - - -

      Triggers an automation stitch for testing purposes.

      - - - public - addSystemAutomationStitchTest( $body) : stdClass - -

      Access Group: sysgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/automation-stitch/test

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemAutomationStitchWebhook() - -

      - - -

      Triggers an incoming webhook for an automation stitch.

      - - - public - addSystemAutomationStitchWebhook( $body) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/automation-stitch/webhook

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemCertificateReadInfo() - -

      - - -

      Get certificate information from a certificate string.

      - - - public - addSystemCertificateReadInfo( $body) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/certificate/read-info

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemChangePasswordSelect() - -

      - - -

      Save admin and guest-admin passwords.

      - - - public - addSystemChangePasswordSelect( $body) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/change-password/select

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemComLogDump() - -

      - - -

      Dump system com-log to file.

      - - - public - addSystemComLogDump() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/com-log/dump

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigRestore() - -

      - - -

      Restore system configuration from uploaded file or from USB.

      - - - public - addSystemConfigRestore( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config/restore

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigRevisionDelete() - -

      - - -

      Deletes one or more system configuration revisions.

      - - - public - addSystemConfigRevisionDelete( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-revision/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigRevisionSave() - -

      - - -

      Create a new config revision checkpoint.

      - - - public - addSystemConfigRevisionSave( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-revision/save

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigRevisionUpdateComments() - -

      - - -

      Updates comments for a system configuration file.

      - - - public - addSystemConfigRevisionUpdateComments( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-revision/update-comments

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigSave() - -

      - - -

      Explicitly save all configuration.

      - - - public - addSystemConfigSave() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config/save

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigScriptDelete() - -

      - - -

      Delete the history of config scripts.

      - - - public - addSystemConfigScriptDelete( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-script/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigScriptRun() - -

      - - -

      Run remote config scripts.

      - - - public - addSystemConfigScriptRun( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-script/run

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemConfigScriptUpload() - -

      - - -

      Upload and run a new configuration script file.

      - - - public - addSystemConfigScriptUpload( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/config-script/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemCsfRegisterAppliance() - -

      - - -

      Register appliance to Security Fabric.

      - - - public - addSystemCsfRegisterAppliance( $body) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/csf/register-appliance

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemDhcp6Revoke() - -

      - - -

      Revoke IPv6 DHCP leases.

      - - - public - addSystemDhcp6Revoke( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/dhcp6/revoke

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemDhcpRevoke() - -

      - - -

      Revoke IPv4 DHCP leases.

      - - - public - addSystemDhcpRevoke( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/dhcp/revoke

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemDisconnectAdminsSelect() - -

      - - -

      Disconnects logged in administrators.

      - - - public - addSystemDisconnectAdminsSelect( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/disconnect-admins/select

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFirmwareUpgrade() - -

      - - -

      Upgrade firmware image on this device using uploaded file.

      - - - public - addSystemFirmwareUpgrade( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/firmware/upgrade

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFortiguardClearStatistics() - -

      - - -

      Immediately clear all FortiGuard statistics.

      - - - public - addSystemFortiguardClearStatistics() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fortiguard/clear-statistics

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFortiguardTestAvailability() - -

      - - -

      Test availability of FortiGuard services.

      - - - public - addSystemFortiguardTestAvailability( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fortiguard/test-availability

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFortiguardUpdate() - -

      - - -

      Immediately update status for FortiGuard services.

      - - - public - addSystemFortiguardUpdate() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fortiguard/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFortimanagerBackupAction() - -

      - - -

      Import or update from FortiManager objects.

      - - - public - addSystemFortimanagerBackupAction( $body) : stdClass - -

      Access Group: fwgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fortimanager/backup-action

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFortimanagerConfig() - -

      - - -

      Configure FortiManager IP. Register FortiManager if 'fortimanager_ip' is provided. Unregister FortiManager if only 'unregister' parameter is specified and set to true.

      - - - public - addSystemFortimanagerConfig( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fortimanager/config

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemFsckStart() - -

      - - -

      Set file system check flag so that it will be executed on next device reboot.

      - - - public - addSystemFsckStart() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/fsck/start

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemHaPeerDisconnect() - -

      - - -

      Update configuration of peer in HA cluster.

      - - - public - addSystemHaPeerDisconnect( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/ha-peer/disconnect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemHaPeerUpdate() - -

      - - -

      Update configuration of peer in HA cluster.

      - - - public - addSystemHaPeerUpdate( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/ha-peer/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemInterfaceDhcpRenew() - -

      - - -

      Renew DHCP lease of an interface.

      - - - public - addSystemInterfaceDhcpRenew( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/interface/dhcp-renew

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemInterfaceSpeedTestTrigger() - -

      - - -

      Run a speed-test on the given interface.

      - - - public - addSystemInterfaceSpeedTestTrigger( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/interface/speed-test-trigger

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemLogdiskFormat() - -

      - - -

      Format log disk.

      - - - public - addSystemLogdiskFormat() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/logdisk/format

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemModemConnect() - -

      - - -

      Trigger a connect for the configured modem.

      - - - public - addSystemModemConnect() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/modem/connect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemModemDisconnect() - -

      - - -

      Trigger a disconnect for the configured modem.

      - - - public - addSystemModemDisconnect() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/modem/disconnect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemModemReset() - -

      - - -

      Reset statistics for internal/external configured modem.

      - - - public - addSystemModemReset() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/modem/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemModemUpdate() - -

      - - -

      Update supported modem list from FortiGuard.

      - - - public - addSystemModemUpdate() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/modem/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemOsReboot() - -

      - - -

      Immediately reboot this device.

      - - - public - addSystemOsReboot( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/os/reboot

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemOsShutdown() - -

      - - -

      Immediately shutdown this device.

      - - - public - addSystemOsShutdown( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/os/shutdown

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemPasswordPolicyConformSelect() - -

      - - -

      Check whether password conforms to the password policy.

      - - - public - addSystemPasswordPolicyConformSelect( $body) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/password-policy-conform/select

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSdnConnectorUpdate() - -

      - - -

      Update an SDN connector's connection status.

      - - - public - addSystemSdnConnectorUpdate( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sdn-connector/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSdnConnectorValidateGcpKey() - -

      - - -

      Validate a string representing a private key from GCP in PEM format.

      - - - public - addSystemSdnConnectorValidateGcpKey( $body) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sdn-connector/validate-gcp-key

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSecurityRatingTrigger() - -

      - - -

      Run a Security Rating report.

      - - - public - addSystemSecurityRatingTrigger( $body) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/security-rating/trigger

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSnifferClear() - -

      - - -

      Clear the results of a specified packet capture.

      - - - public - addSystemSnifferClear( $body) : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sniffer/clear

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSnifferRestart() - -

      - - -

      Restart specified packet capture.

      - - - public - addSystemSnifferRestart( $body) : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sniffer/restart

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSnifferStart() - -

      - - -

      Start specified packet capture.

      - - - public - addSystemSnifferStart( $body) : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sniffer/start

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemSnifferStop() - -

      - - -

      Stop specified packet capture.

      - - - public - addSystemSnifferStop( $body) : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/sniffer/stop

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemTimeSet() - -

      - - -

      Sets current system time stamp.

      - - - public - addSystemTimeSet( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/time/set

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemUsbDeviceEject() - -

      - - -

      Eject USB drives for safe removal.

      - - - public - addSystemUsbDeviceEject() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/usb-device/eject

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemUsbLogStart() - -

      - - -

      Start backup of logs from current VDOM to USB drive.

      - - - public - addSystemUsbLogStart() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/usb-log/start

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemUsbLogStop() - -

      - - -

      Stop backup of logs to USB drive.

      - - - public - addSystemUsbLogStop() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/usb-log/stop

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addSystemVmlicenseUpload() - -

      - - -

      Update VM license using uploaded file. Reboots immediately if successful.

      - - - public - addSystemVmlicenseUpload( $body) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /system/vmlicense/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserBannedAdd_users() - -

      - - -

      Immediately add one or more users to the banned list.

      - - - public - addUserBannedAdd_users( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/banned/add_users

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserBannedClear_all() - -

      - - -

      Immediately clear all banned users.

      - - - public - addUserBannedClear_all() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/banned/clear_all

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserBannedClear_users() - -

      - - -

      Immediately clear a list of specific banned users by IP.

      - - - public - addUserBannedClear_users( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/banned/clear_users

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserDeviceRemove() - -

      - - -

      Remove single or multiple user devices specified by host MAC addresses.

      - - - public - addUserDeviceRemove( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/device/remove

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFirewallAuth() - -

      - - -

      Trigger authentication for a single firewall user.

      - - - public - addUserFirewallAuth( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/firewall/auth

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFirewallDeauth() - -

      - - -

      Deauthenticate single, multiple, or all firewall users.

      - - - public - addUserFirewallDeauth( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/firewall/deauth

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenActivate() - -

      - - -

      Activate a set of FortiTokens by serial number.

      - - - public - addUserFortitokenActivate( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/activate

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenImportMobile() - -

      - - -

      Import a list of tokens from FortiGuard to the FortiGate unit.

      - - - public - addUserFortitokenImportMobile( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/import-mobile

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenImportSeed() - -

      - - -

      Import a FortiToken seed file.

      - - - public - addUserFortitokenImportSeed( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/import-seed

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenImportTrial() - -

      - - -

      Import trial mobile FortiTokens.

      - - - public - addUserFortitokenImportTrial() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/import-trial

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenProvision() - -

      - - -

      Provision a set of FortiTokens by serial number.

      - - - public - addUserFortitokenProvision( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/provision

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenRefresh() - -

      - - -

      Refresh a set of FortiTokens by serial number.

      - - - public - addUserFortitokenRefresh( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/refresh

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFortitokenSendActivation() - -

      - - -

      Send a FortiToken activation code to a user via SMS or Email.

      - - - public - addUserFortitokenSendActivation( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fortitoken/send-activation

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserFssoRefreshServer() - -

      - - -

      Refresh remote agent group list for all fsso agents.

      - - - public - addUserFssoRefreshServer() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/fsso/refresh-server

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserGuestEmail() - -

      - - -

      Sent guest login details via email.

      - - - public - addUserGuestEmail( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/guest/email

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserGuestSms() - -

      - - -

      Sent guest login details via SMS.

      - - - public - addUserGuestSms( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/guest/sms

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserRadiusTestConnect() - -

      - - -

      Test the connectivity of the given RADIUS server and, optionally, the validity of a username & password.

      - - - public - addUserRadiusTestConnect( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/radius/test-connect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUserTacacsPlusTest() - -

      - - -

      Test the connectivity of the given TACACS+ server.

      - - - public - addUserTacacsPlusTest( $body) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /user/tacacs-plus/test

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addUtmRatingLookupSelect() - -

      - - -

      Lookup FortiGuard rating for a specific URL.

      - - - public - addUtmRatingLookupSelect( $body) : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /utm/rating-lookup/select

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnCertificateCaImport() - -

      - - -

      Import CA certificate.

      - - - public - addVpnCertificateCaImport( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn-certificate/ca/import

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnCertificateCrlImport() - -

      - - -

      Import certificate revocation lists (CRL) from file content.

      - - - public - addVpnCertificateCrlImport( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn-certificate/crl/import

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnCertificateCsrGenerate() - -

      - - -

      Generate a certificate signing request (CSR) and a private key. The CSR can be retrieved / downloaded from CLI, GUI and REST API.

      - - - public - addVpnCertificateCsrGenerate( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn-certificate/csr/generate

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnCertificateLocalImport() - -

      - - -

      Import local certificate.

      - - - public - addVpnCertificateLocalImport( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn-certificate/local/import

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnCertificateRemoteImport() - -

      - - -

      Import remote certificate.

      - - - public - addVpnCertificateRemoteImport( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn-certificate/remote/import

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnIkeClear() - -

      - - -

      Clear IKE gateways.

      - - - public - addVpnIkeClear( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ike/clear

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnIpsecTunnel_down() - -

      - - -

      Bring down a specific IPsec VPN tunnel.

      - - - public - addVpnIpsecTunnel_down( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ipsec/tunnel_down

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnIpsecTunnel_reset_stats() - -

      - - -

      Reset statistics for a specific IPsec VPN tunnel.

      - - - public - addVpnIpsecTunnel_reset_stats( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ipsec/tunnel_reset_stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnIpsecTunnel_up() - -

      - - -

      Bring up a specific IPsec VPN tunnel.

      - - - public - addVpnIpsecTunnel_up( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ipsec/tunnel_up

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnSslClear_tunnel() - -

      - - -

      Remove all active tunnel sessions in current virtual domain.

      - - - public - addVpnSslClear_tunnel() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ssl/clear_tunnel

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnSslDelete() - -

      - - -

      Terminate the provided SSL-VPN session.

      - - - public - addVpnSslDelete( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ssl/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addVpnSslProvisionUser() - -

      - - -

      Provision SSL-VPN users with target applications. The provisioning message (email or SMS) is sent with no confirmation of success.

      - - - public - addVpnSslProvisionUser( $body) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /vpn/ssl/provision-user

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWanoptHistoryReset() - -

      - - -

      Reset WAN opt. statistics.

      - - - public - addWanoptHistoryReset() : stdClass - -

      Access Group: wanoptgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wanopt/history/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWanoptPeer_statsReset() - -

      - - -

      Reset WAN opt peer statistics.

      - - - public - addWanoptPeer_statsReset() : stdClass - -

      Access Group: wanoptgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wanopt/peer_stats/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWanoptWebcacheReset() - -

      - - -

      Reset webcache statistics.

      - - - public - addWanoptWebcacheReset() : stdClass - -

      Access Group: wanoptgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wanopt/webcache/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebcacheStatsReset() - -

      - - -

      Reset all webcache statistics.

      - - - public - addWebcacheStatsReset() : stdClass - -

      Access Group: wanoptgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /webcache/stats/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebfilterCategoryQuotaReset() - -

      - - -

      Reset webfilter quota for user or IP.

      - - - public - addWebfilterCategoryQuotaReset( $body) : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /webfilter/category-quota/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebfilterOverrideDelete() - -

      - - -

      Delete a configured webfilter override.

      - - - public - addWebfilterOverrideDelete( $body) : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /webfilter/override/delete

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebproxyPacfileUpload() - -

      - - -

      Upload webproxy PAC file.

      - - - public - addWebproxyPacfileUpload( $body) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /webproxy/pacfile/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebUiCustomLanguageCreate() - -

      - - -

      Upload custom language file to this Fortigate.

      - - - public - addWebUiCustomLanguageCreate( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /web-ui/custom-language/create

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebUiCustomLanguageUpdate() - -

      - - -

      Update custom language file to this Fortigate.

      - - - public - addWebUiCustomLanguageUpdate( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /web-ui/custom-language/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWebUiLanguageImport() - -

      - - -

      Import localization language file to this FortiGate.

      - - - public - addWebUiLanguageImport( $body) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /web-ui/language/import

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiClientDisassociate() - -

      - - -

      Disassociate a WiFi client from the FortiAP it's currently connected to. The client will need to reassociate with the same FortiAP or another to resume connectivity.

      - - - public - addWifiClientDisassociate( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/client/disassociate

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiEuclidReset() - -

      - - -

      Reset presence analytics statistics.

      - - - public - addWifiEuclidReset() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/euclid/reset

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiFirmwareDownload() - -

      - - -

      Download FortiAP firmware from FortiGuard to the FortiGate according to FortiAP image ID.

      - - - public - addWifiFirmwareDownload( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/firmware/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiFirmwarePush() - -

      - - -

      Push FortiAP firmware to the given device.

      - - - public - addWifiFirmwarePush( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/firmware/push

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiFirmwareUpload() - -

      - - -

      Upload FortiAP firmware to the management FortiGate and then push to target FortiAPs.

      - - - public - addWifiFirmwareUpload( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/firmware/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiManaged_apLedBlink() - -

      - - -

      Turn a managed FortiAP's LED blinking on or off.

      - - - public - addWifiManaged_apLedBlink( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/managed_ap/led-blink

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiManaged_apRestart() - -

      - - -

      Restart a given FortiAP.

      - - - public - addWifiManaged_apRestart( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/managed_ap/restart

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiManaged_apSet_status() - -

      - - -

      Update administrative state for a given FortiAP (enable or disable authorization).

      - - - public - addWifiManaged_apSet_status( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/managed_ap/set_status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiNetworkConnect() - -

      - - -

      When FortiWiFi is in client mode, connect to the specified network, if configured in the 'wifi' interface.

      - - - public - addWifiNetworkConnect( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/network/connect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiNetworkScan() - -

      - - -

      When FortiWiFi is in client mode, start a scan for local WiFi networks.

      - - - public - addWifiNetworkScan() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/network/scan

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiRegionImageUpload() - -

      - - -

      Saves a floorplan/region image to an existing region.

      - - - public - addWifiRegionImageUpload( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/region-image/upload

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiRogue_apClear_all() - -

      - - -

      Clear all detected rogue APs.

      - - - public - addWifiRogue_apClear_all() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/rogue_ap/clear_all

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiRogue_apSet_status() - -

      - - -

      Mark detected APs as rogue APs.

      - - - public - addWifiRogue_apSet_status( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/rogue_ap/set_status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiSpectrumKeepAlive() - -

      - - -

      Extend duration of an existing spectrum analysis for a specific FortiAP.

      - - - public - addWifiSpectrumKeepAlive( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/spectrum/keep-alive

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiSpectrumStart() - -

      - - -

      Start spectrum analysis for a specific FortiAP for a duration of time.

      - - - public - addWifiSpectrumStart( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/spectrum/start

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiSpectrumStop() - -

      - - -

      Stop spectrum analysis for a specific FortiAP.

      - - - public - addWifiSpectrumStop( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/spectrum/stop

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiSsidGenerateKeys() - -

      - - -

      Generate pre-shared keys for specific multi pre-shared key profile.

      - - - public - addWifiSsidGenerateKeys( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/ssid/generate-keys

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiVlanProbeStart() - -

      - - -

      Start a VLAN probe.

      - - - public - addWifiVlanProbeStart( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/vlan-probe/start

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - addWifiVlanProbeStop() - -

      - - -

      Stop a VLAN probe.

      - - - public - addWifiVlanProbeStop( $body) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $body - : -
      -
      -

      Possible parameters to go in the body for the request.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      POST /wifi/vlan-probe/stop

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - commitTransaction() - -

      - - -

      Commit a transaction (apply operations).

      - - - public - commitTransaction([string|null $vdom = null ]) : bool - -
      - -
      Parameters
      -
      -
      - $vdom - : string|null - = null
      -
      -

      Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

      -
      - -
      -
      - - - -
      Return values
      - bool - — -

      Return TRUE on success and FALSE on failure.

      -
      - - -
      -
      -

      - getAllAzureApplicationList() - -

      - - -

      Retrieve a list of Azure applications that can be used for configuring an Azure SDN connector.

      - - - public - getAllAzureApplicationList() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /azure/application-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlAvatarDownload() - -

      - - -

      Download an endpoint avatar image.

      - - - public - getAllEndpointControlAvatarDownload([ $uid = null ][,  $user = null ][,  $fingerprint = null ][,  $default = null ]) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $uid - : - = null
      -
      -

      Single FortiClient UID.

      -
      - -
      -
      - $user - : - = null
      -
      -

      User name of the endpoint.

      -
      - -
      -
      - $fingerprint - : - = null
      -
      -

      Avatar fingerprint.

      -
      - -
      -
      - $default - : - = null
      -
      -

      Default avatar name ['authuser'|'unauthuser'|'authuser_72'|'unauthuser_72']. Default avatar when endpoint / device avatar is not available. If default is not set, Not found 404 is returned.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/avatar/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlEmsCertStatus() - -

      - - -

      Retrieve authentication status of the EMS server certificate for a specific EMS.

      - - - public - getAllEndpointControlEmsCertStatus( $ems_name[,  $with_cert = null ]) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $ems_name - : -
      -
      -

      EMS server name (as defined in CLI table endpoint-control.fctems).

      -
      - -
      -
      - $with_cert - : - = null
      -
      -

      Return detailed certificate information. Available when the certificate is authenticated by installed CA certificates.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/ems/cert-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlEmsStatus() - -

      - - -

      Retrieve EMS connection status for a specific EMS.

      - - - public - getAllEndpointControlEmsStatus( $ems_name) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $ems_name - : -
      -
      -

      EMS server name (as defined in CLI table endpoint-control.fctems).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/ems/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlEmsStatusSummary() - -

      - - -

      Retrieve status summary for all configured EMS.

      - - - public - getAllEndpointControlEmsStatusSummary() : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/ems/status-summary

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlInstaller() - -

      - - -

      List available FortiClient installers.

      - - - public - getAllEndpointControlInstaller([ $min_version = null ]) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $min_version - : - = null
      -
      -

      Filter: Minimum installer version. (String of the format n[.n[.n]]).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/installer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlInstallerDownload() - -

      - - -

      Download a FortiClient installer via FortiGuard.

      - - - public - getAllEndpointControlInstallerDownload( $mkey) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Name of installer (image_id).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/installer/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlRecordList() - -

      - - -

      List endpoint records.

      - - - public - getAllEndpointControlRecordList([ $intf_name = null ]) : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - -
      Parameters
      -
      -
      - $intf_name - : - = null
      -
      -

      Filter: Name of interface where the endpoint was detected.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/record-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllEndpointControlSummary() - -

      - - -

      Summary of FortiClient endpoint records.

      - - - public - getAllEndpointControlSummary() : stdClass - -

      Access Group: utmgrp.endpoint-control

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /endpoint-control/summary

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllExtenderControllerExtender() - -

      - - -

      Retrieve statistics for specific configured FortiExtender units.

      - - - public - getAllExtenderControllerExtender( $id[,  $name = null ][,  $type = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $id - : -
      -
      -

      FortiExtender ID.

      -
      - -
      -
      - $name - : - = null
      -
      -

      List of FortiExtender IDs to query.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Statistic type.'type' options are [system | modem | usage | last]. If 'type' is not specified, all types of statistics are retrieved.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /extender-controller/extender

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAcl() - -

      - - -

      List counters for all IPv4 ACL.

      - - - public - getAllFirewallAcl() : stdClass - -

      Access Group: fwgrp.policy

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/acl

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAcl6() - -

      - - -

      List counters for all IPv6 ACL.

      - - - public - getAllFirewallAcl6() : stdClass - -

      Access Group: fwgrp.policy

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/acl6

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAddress6Dynamic() - -

      - - -

      List of IPv6 Fabric Connector address objects and the IPs they resolve to.

      - - - public - getAllFirewallAddress6Dynamic() : stdClass - -

      Access Group: fwgrp.address

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/address6-dynamic

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAddressDynamic() - -

      - - -

      List of Fabric Connector address objects and the IPs they resolve to.

      - - - public - getAllFirewallAddressDynamic() : stdClass - -

      Access Group: fwgrp.address

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/address-dynamic

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAddressFqdns() - -

      - - -

      List of FQDN address objects and the IPs they resolved to.

      - - - public - getAllFirewallAddressFqdns() : stdClass - -

      Access Group: fwgrp.address

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/address-fqdns

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallAddressFqdns6() - -

      - - -

      List of IPv6 FQDN address objects and the IPs they resolved to.

      - - - public - getAllFirewallAddressFqdns6() : stdClass - -

      Access Group: fwgrp.address

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/address-fqdns6

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallHealth() - -

      - - -

      List configured load balance server health monitors.

      - - - public - getAllFirewallHealth() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/health

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallInternetServiceDetails() - -

      - - -

      List all details for a given Internet Service ID.

      - - - public - getAllFirewallInternetServiceDetails( $id[,  $country_id = null ][,  $region_id = null ][,  $city_id = null ][,  $start = null ][,  $count = null ][,  $summary_only = null ]) : stdClass - -

      Access Group: fwgrp.address

      -
      - -
      Parameters
      -
      -
      - $id - : -
      -
      -

      ID of the Internet Service to get details for.

      -
      - -
      -
      - $country_id - : - = null
      -
      -

      Filter: Country ID.

      -
      - -
      -
      - $region_id - : - = null
      -
      -

      Filter: Region ID.

      -
      - -
      -
      - $city_id - : - = null
      -
      -

      Filter: City ID.

      -
      - -
      -
      - $start - : - = null
      -
      -

      Starting entry index. If a value is less than zero, it will be set to zero.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down. Default value is 1000.

      -
      - -
      -
      - $summary_only - : - = null
      -
      -

      Only return number of entries instead of entries.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/internet-service-details

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallInternetServiceMatch() - -

      - - -

      List internet services that exist at a given IP or Subnet.

      - - - public - getAllFirewallInternetServiceMatch( $ip,  $mask) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $ip - : -
      -
      -

      IP (in dot-decimal notation).

      -
      - -
      -
      - $mask - : -
      -
      -

      IP Mask (in dot-decimal notation).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/internet-service-match

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallIppool() - -

      - - -

      List IPv4 pool statistics.

      - - - public - getAllFirewallIppool() : stdClass - -

      Access Group: fwgrp.policy

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/ippool

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallIppoolMapping() - -

      - - -

      Get the list of IPv4 mappings for the specified IP pool.

      - - - public - getAllFirewallIppoolMapping( $mkey) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      The IP pool name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/ippool/mapping

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallLoadBalance() - -

      - - -

      List all firewall load balance servers.

      - - - public - getAllFirewallLoadBalance([ $start = null ],  $count) : stdClass - -

      Access Group: fwgrp.others

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : -
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/load-balance

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallLocalIn() - -

      - - -

      List implicit and explicit local-in firewall policies.

      - - - public - getAllFirewallLocalIn() : stdClass - -

      Access Group: fwgrp.policy

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/local-in

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallPerIpShaper() - -

      - - -

      List of statistics for configured firewall per-IP traffic shapers.

      - - - public - getAllFirewallPerIpShaper() : stdClass - -

      Access Group: fwgrp.others

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/per-ip-shaper

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallPolicy() - -

      - - -

      List traffic statistics for firewall policies.

      - - - public - getAllFirewallPolicy([ $policyid = null ][,  $ip_version = null ]) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $policyid - : - = null
      -
      -

      Filter: Policy ID.

      -
      - -
      -
      - $ip_version - : - = null
      -
      -

      Filter: Traffic IP Version. [ ipv4 | ipv6 ], if left empty, will retrieve data for both ipv4 and ipv6.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/policy

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallPolicyLookup() - -

      - - -

      Performs a policy lookup by creating a dummy packet and asking the kernel which policy would be hit.

      - - - public - getAllFirewallPolicyLookup([ $ipv6 = null ],  $srcintf[,  $sourceport = null ][,  $sourceip = null ],  $protocol,  $dest[,  $destport = null ][,  $icmptype = null ][,  $icmpcode = null ]) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $ipv6 - : - = null
      -
      -

      Perform an IPv6 lookup?

      -
      - -
      -
      - $srcintf - : -
      -
      -

      Source interface.

      -
      - -
      -
      - $sourceport - : - = null
      -
      -

      Source port.

      -
      - -
      -
      - $sourceip - : - = null
      -
      -

      Source IP.

      -
      - -
      -
      - $protocol - : -
      -
      -

      Protocol.

      -
      - -
      -
      - $dest - : -
      -
      -

      Destination IP/FQDN.

      -
      - -
      -
      - $destport - : - = null
      -
      -

      Destination port.

      -
      - -
      -
      - $icmptype - : - = null
      -
      -

      ICMP type.

      -
      - -
      -
      - $icmpcode - : - = null
      -
      -

      ICMP code.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/policy-lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallProxyPolicy() - -

      - - -

      List traffic statistics for all explicit proxy policies.

      - - - public - getAllFirewallProxyPolicy([ $policyid = null ]) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $policyid - : - = null
      -
      -

      Filter: Policy ID.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/proxy-policy

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallSdnConnectorFilters() - -

      - - -

      List all available filters for a specified SDN Fabric Connector. Used for Fabric Connector address objects.

      - - - public - getAllFirewallSdnConnectorFilters( $connector) : stdClass - -

      Access Group: fwgrp.address

      -
      - -
      Parameters
      -
      -
      - $connector - : -
      -
      -

      Name of the SDN Fabric Connector to get the filters from.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/sdn-connector-filters

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallSecurityPolicy() - -

      - - -

      List IPS engine statistics for security policies.

      - - - public - getAllFirewallSecurityPolicy([ $policyid = null ]) : stdClass - -

      Access Group: fwgrp.policy

      -
      - -
      Parameters
      -
      -
      - $policyid - : - = null
      -
      -

      Filter: Policy ID.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/security-policy

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallSession() - -

      - - -

      List all active firewall sessions (optionally filtered).

      - - - public - getAllFirewallSession([ $ip_version = null ][,  $start = null ],  $count[,  $summary = null ][,  $sourceport = null ][,  $policyid = null ][,  $application = null ][,  $protocol = null ][,  $destport = null ][,  $srcintf = null ][,  $dstintf = null ][,  $srcintfrole = null ][,  $dstintfrole = null ][,  $source = null ][,  $srcuuid = null ][,  $destination = null ][,  $dstuuid = null ][,  $username = null ][,  $shaper = null ][,  $country = null ][,  $owner = null ][,  $natsourceaddress = null ][,  $natsourceport = null ][,  $filterCsf = null ][,  $since = null ][,  $seconds = null ][,  $webDomain = null ][,  $webCategory = null ][,  $fortiasic = null ][,  $nturbo = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $ip_version - : - = null
      -
      -

      IP version [*ipv4 | ipv6 | ipboth].

      -
      - -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : -
      -
      -

      Maximum number of entries to return. Valid range is [20, 1000]; if a value is specified out of that range, it will be rounded up or down.

      -
      - -
      -
      - $summary - : - = null
      -
      -

      Enable/disable inclusion of session summary (setup rate, total sessions, etc).

      -
      - -
      -
      - $sourceport - : - = null
      -
      -

      Filter: Source port.

      -
      - -
      -
      - $policyid - : - = null
      -
      -

      Filter: Policy ID.

      -
      - -
      -
      - $application - : - = null
      -
      -

      Filter: Application PROTO/PORT. (e.g. "TCP/443")

      -
      - -
      -
      - $protocol - : - = null
      -
      -

      Filter: Protocol name [all|igmp|tcp|udp|icmp|etc].

      -
      - -
      -
      - $destport - : - = null
      -
      -

      Filter: Destination port.

      -
      - -
      -
      - $srcintf - : - = null
      -
      -

      Filter: Source interface name.

      -
      - -
      -
      - $dstintf - : - = null
      -
      -

      Filter: Destination interface name.

      -
      - -
      -
      - $srcintfrole - : - = null
      -
      -

      Filter: Source interface roles.

      -
      - -
      -
      - $dstintfrole - : - = null
      -
      -

      Filter: Destination interface roles.

      -
      - -
      -
      - $source - : - = null
      -
      -

      Filter: Source IP address.

      -
      - -
      -
      - $srcuuid - : - = null
      -
      -

      Filter: Source UUID.

      -
      - -
      -
      - $destination - : - = null
      -
      -

      Filter: Destination IP address.

      -
      - -
      -
      - $dstuuid - : - = null
      -
      -

      Filter: Destination UUID.

      -
      - -
      -
      - $username - : - = null
      -
      -

      Filter: Authenticated username.

      -
      - -
      -
      - $shaper - : - = null
      -
      -

      Filter: Forward traffic shaper name.

      -
      - -
      -
      - $country - : - = null
      -
      -

      Filter: Destination country name.

      -
      - -
      -
      - $owner - : - = null
      -
      -

      Filter: Destination owner.

      -
      - -
      -
      - $natsourceaddress - : - = null
      -
      -

      Filter: NAT source address.

      -
      - -
      -
      - $natsourceport - : - = null
      -
      -

      Filter: NAT source port.

      -
      - -
      -
      - $filterCsf - : - = null
      -
      -

      Filter: Include sessions from downstream fortigates.

      -
      - -
      -
      - $since - : - = null
      -
      -

      Filter: Only return sessions generated since this Unix timestamp.

      -
      - -
      -
      - $seconds - : - = null
      -
      -

      Filter: Only return sessions generated in the last N seconds.

      -
      - -
      -
      - $webDomain - : - = null
      -
      -

      Filter: Web domain.

      -
      - -
      -
      - $webCategory - : - = null
      -
      -

      Filter: Web category.

      -
      - -
      -
      - $fortiasic - : - = null
      -
      -

      Filter: 1 to include NPU accelerated sessions, 0 to exclude.

      -
      - -
      -
      - $nturbo - : - = null
      -
      -

      Filter: 1 to include nTurbo sessions, 0 to exclude.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/session

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallShaper() - -

      - - -

      List of statistics for configured firewall shared traffic shapers.

      - - - public - getAllFirewallShaper() : stdClass - -

      Access Group: fwgrp.others

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/shaper

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallUuidList() - -

      - - -

      Retrieve a list of all UUIDs with their object type and VDOM.

      - - - public - getAllFirewallUuidList() : stdClass - -

      Access Group: fwgrp.address

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/uuid-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFirewallUuidTypeLookup() - -

      - - -

      Retrieve a mapping of UUIDs to their firewall object type for given UUIDs.

      - - - public - getAllFirewallUuidTypeLookup([ $uuids = null ]) : stdClass - -

      Access Group: fwgrp.address

      -
      - -
      Parameters
      -
      -
      - $uuids - : - = null
      -
      -

      List of UUIDs to be resolved.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /firewall/uuid-type-lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFortiguardRedirectPortal() - -

      - - -

      Retrieve the FortiGuard redirect portal IP.

      - - - public - getAllFortiguardRedirectPortal() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /fortiguard/redirect-portal

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFortiguardServiceCommunicationStats() - -

      - - -

      Retrieve historical statistics for communication with FortiGuard services.

      - - - public - getAllFortiguardServiceCommunicationStats([ $service_type = null ][,  $timeslot = null ]) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $service_type - : - = null
      -
      -

      To get stats for [forticare|fortiguard_download|fortiguard_query|forticloud_log|fortisandbox_cloud|fortiguard.com|ocvpn|sdns|fortitoken_registration|sms_service]. Defaults to all stats if not provided.

      -
      - -
      -
      - $timeslot - : - = null
      -
      -

      History timeslot of stats [1_hour|24_hour|1_week]. Defaults to all timeslots if not provided.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /fortiguard/service-communication-stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFortiviewSandboxFileDetails() - -

      - - -

      Retrieve FortiSandbox analysis details for a specific file checksum.

      - - - public - getAllFortiviewSandboxFileDetails( $checksum) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $checksum - : -
      -
      -

      Checksum of a specific file that has been analyzed by the connected FortiSandbox.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /fortiview/sandbox-file-details

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFortiviewSandboxFileList() - -

      - - -

      Retrieve list of available FortiSandbox analysis files.

      - - - public - getAllFortiviewSandboxFileList() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /fortiview/sandbox-file-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllFortiviewStatistics() - -

      - - -

      Retrieve drill-down and summary data for FortiView (both realtime and historical).

      - - - public - getAllFortiviewStatistics([ $realtime = null ][,  $filter = null ][,  $sessionid = null ][,  $count = null ][,  $device = null ][,  $report_by = null ][,  $sort_by = null ][,  $chart_only = null ][,  $start = null ][,  $end = null ][,  $ip_version = null ]) : stdClass - -

      Access Group: ftviewgrp

      -
      - -
      Parameters
      -
      -
      - $realtime - : - = null
      -
      -

      Set to true to retrieve realtime results (from kernel).

      -
      - -
      -
      - $filter - : - = null
      -
      -

      A map of filter keys to arrays of values.

      -
      - -
      -
      - $sessionid - : - = null
      -
      -

      FortiView request Session ID.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of details to return.

      -
      - -
      -
      - $device - : - = null
      -
      -

      FortiView source device [disk|fortianalyzer|forticloud].

      -
      - -
      -
      - $report_by - : - = null
      -
      -

      Report by field.

      -
      - -
      -
      - $sort_by - : - = null
      -
      -

      Sort by field.

      -
      - -
      -
      - $chart_only - : - = null
      -
      -

      Only return graph values in results.

      -
      - -
      -
      - $start - : - = null
      -
      -

      Start timestamp.

      -
      - -
      -
      - $end - : - = null
      -
      -

      End timestamp.

      -
      - -
      -
      - $ip_version - : - = null
      -
      -

      IP version [*ipv4 | ipv6 | ipboth].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /fortiview/statistics

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllIpsAnomaly() - -

      - - -

      Returns IPS anomaly list.

      - - - public - getAllIpsAnomaly() : stdClass - -

      Access Group: utmgrp.ips

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /ips/anomaly

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllIpsExceedScanRange() - -

      - - -

      Returns a list of applications that exceed the scan range from a list of application IDs.

      - - - public - getAllIpsExceedScanRange( $ids) : stdClass - -

      Access Group: utmgrp.ips

      -
      - -
      Parameters
      -
      -
      - $ids - : -
      -
      -

      List of application IDs.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /ips/exceed-scan-range

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllIpsMetadata() - -

      - - -

      Returns IPS meta data.

      - - - public - getAllIpsMetadata() : stdClass - -

      Access Group: utmgrp.ips

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /ips/metadata

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllIpsRateBased() - -

      - - -

      Returns a list of rate-based signatures in IPS package.

      - - - public - getAllIpsRateBased() : stdClass - -

      Access Group: utmgrp.ips

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /ips/rate-based

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLicenseFortianalyzerStatus() - -

      - - -

      Get current license & registration status for the connected FortiAnalyzer.

      - - - public - getAllLicenseFortianalyzerStatus() : stdClass - -

      Access Group: secfabgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /license/fortianalyzer-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLicenseForticareOrgList() - -

      - - -

      Get FortiCare organization size and industry lists.

      - - - public - getAllLicenseForticareOrgList() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /license/forticare-org-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLicenseForticareResellers() - -

      - - -

      Get current FortiCare resellers for the requested country.

      - - - public - getAllLicenseForticareResellers([ $country_code = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $country_code - : - = null
      -
      -

      FortiGuard country code

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /license/forticare-resellers

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLicenseStatus() - -

      - - -

      Get current license & registration status.

      - - - public - getAllLicenseStatus() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /license/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogAvArchiveDownload() - -

      - - -

      Download file quarantined by AntiVirus.

      - - - public - getAllLogAvArchiveDownload( $mkey) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Checksum for quarantined file.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/av-archive/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogCurrentDiskUsage() - -

      - - -

      Return current used, free and total disk bytes.

      - - - public - getAllLogCurrentDiskUsage() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/current-disk-usage

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogDeviceState() - -

      - - -

      Retrieve information on state of log devices.

      - - - public - getAllLogDeviceState() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/device/state

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogEvent() - -

      - - -

      List all event log descriptions. Deprecated in 6.2.3 replaced by /api/v2/static/logid_metadata.json.

      - - - public - getAllLogEvent() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/event

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogFortianalyzer() - -

      - - -

      Return FortiAnalyzer/FortiManager log status.

      - - - public - getAllLogFortianalyzer([ $scope = null ][,  $server = null ][,  $srcip = null ]) : stdClass - -

      Access Group: loggrp.config

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to test the connectivity of the FortiAnalyzer address [vdom|global].

      -
      - -
      -
      - $server - : - = null
      -
      -

      FortiAnalyzer/FortiManager address.

      -
      - -
      -
      - $srcip - : - = null
      -
      -

      The IP to use to make the request to the FortiAnalyzer [|auto]. When set to "auto" it will use the FortiGate's routing table to determine the IP to make the request from.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/fortianalyzer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogFortianalyzerQueue() - -

      - - -

      Retrieve information on FortiAnalyzer's queue state. Note:- FortiAnalyzer logs are queued only if upload-option is realtime.

      - - - public - getAllLogFortianalyzerQueue([ $scope = null ]) : stdClass - -

      Access Group: loggrp.config

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve FortiAnalyzer's queue state [vdom*|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/fortianalyzer-queue

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogForticloud() - -

      - - -

      Return FortiCloud log status.

      - - - public - getAllLogForticloud() : stdClass - -

      Access Group: loggrp.config

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/forticloud

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogForticloudReportDownload() - -

      - - -

      Download PDF report from FortiCloud.

      - - - public - getAllLogForticloudReportDownload( $mkey[,  $inline = null ]) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      FortiCloud Report ID.

      -
      - -
      -
      - $inline - : - = null
      -
      -

      Set to 1 to download the report inline.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/forticloud-report/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogForticloudReportList() - -

      - - -

      Get FortiCloud report list.

      - - - public - getAllLogForticloudReportList() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/forticloud-report-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogHistoricDailyRemoteLogs() - -

      - - -

      Returns the amount of logs in bytes sent daily to a remote logging service (FortiCloud or FortiAnalyzer).

      - - - public - getAllLogHistoricDailyRemoteLogs( $server) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $server - : -
      -
      -

      Service name [forticloud | fortianalyzer].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/historic-daily-remote-logs

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogHourlyDiskUsage() - -

      - - -

      Return historic hourly disk usage in bytes.

      - - - public - getAllLogHourlyDiskUsage() : stdClass - -

      Access Group: loggrp.data-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/hourly-disk-usage

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogIpsArchiveDownload() - -

      - - -

      Download IPS/application control packet capture files. Uses configured log display device.

      - - - public - getAllLogIpsArchiveDownload( $mkey[,  $pcap_no = null ][,  $pcap_category = null ]) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      IPS archive ID.

      -
      - -
      -
      - $pcap_no - : - = null
      -
      -

      Packet capture roll number (required when log device is 'disk')

      -
      - -
      -
      - $pcap_category - : - = null
      -
      -

      Packet capture category (required when log device is 'disk')

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/ips-archive/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogLocalReportDownload() - -

      - - -

      Download local report -Access Group: loggrp.data-access

      - - - public - getAllLogLocalReportDownload( $mkey) : stdClass - -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Local Report Name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/local-report/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogLocalReportList() - -

      - - -

      Get local reports list.

      - - - public - getAllLogLocalReportList() : stdClass - -

      Access Group: loggrp.report-access

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/local-report-list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogPolicyArchiveDownload() - -

      - - -

      Download policy-based packet capture archive.

      - - - public - getAllLogPolicyArchiveDownload( $mkey,  $srcip,  $dstip) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Session ID (from traffic log).

      -
      - -
      -
      - $srcip - : -
      -
      -

      Source IP.

      -
      - -
      -
      - $dstip - : -
      -
      -

      Destination IP.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/policy-archive/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllLogStats() - -

      - - -

      Return number of logs sent by category per day for a specific log device.

      - - - public - getAllLogStats([ $dev = null ]) : stdClass - -

      Access Group: loggrp.data-access

      -
      - -
      Parameters
      -
      -
      - $dev - : - = null
      -
      -

      Log device [*memory | disk | fortianalyzer | forticloud].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /log/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkArp() - -

      - - -

      Get IPv4 ARP table.

      - - - public - getAllNetworkArp() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/arp

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkDdnsLookup() - -

      - - -

      Check DDNS FQDN availability.

      - - - public - getAllNetworkDdnsLookup( $domain) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $domain - : -
      -
      -

      Filter: domain to check.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/ddns/lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkDdnsServers() - -

      - - -

      Get DDNS servers.

      - - - public - getAllNetworkDdnsServers() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/ddns/servers

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkDnsLatency() - -

      - - -

      Get DNS latency.

      - - - public - getAllNetworkDnsLatency() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/dns/latency

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkFortiguardLiveServicesLatency() - -

      - - -

      Get latency information for live FortiGuard services.

      - - - public - getAllNetworkFortiguardLiveServicesLatency() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/fortiguard/live-services-latency

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkLldpNeighbors() - -

      - - -

      List all active LLDP neighbors.

      - - - public - getAllNetworkLldpNeighbors() : stdClass - -

      Access Group: netgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/lldp/neighbors

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkLldpPorts() - -

      - - -

      List all active LLDP ports.

      - - - public - getAllNetworkLldpPorts([ $mkey = null ]) : stdClass - -

      Access Group: netgrp

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: specific port name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/lldp/ports

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNetworkReverseIpLookup() - -

      - - -

      Retrieve the resolved DNS domain name for a given IP address.

      - - - public - getAllNetworkReverseIpLookup( $ip) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $ip - : -
      -
      -

      IP address (in dot-decimal notation).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /network/reverse-ip-lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNsxInstance() - -

      - - -

      List NSX instances and their resource statistics.

      - - - public - getAllNsxInstance([ $mkey = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: NSX SDN name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /nsx/instance

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllNsxServiceStatus() - -

      - - -

      Retrieve NSX service status.

      - - - public - getAllNsxServiceStatus([ $mkey = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: NSX SDN name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /nsx/service/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRegistrationForticloudDeviceStatus() - -

      - - -

      Fetch device registration status from FortiCloud. Currently FortiSwitch and FortiAP are supported.

      - - - public - getAllRegistrationForticloudDeviceStatus( $serials[,  $update_cache = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $serials - : -
      -
      -

      Serials of FortiSwitch and FortiAP to fetch registration status.

      -
      - -
      -
      - $update_cache - : - = null
      -
      -

      Clear cache and retrieve updated data.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /registration/forticloud/device-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRegistrationForticloudDisclaimer() - -

      - - -

      Retrieve the FortiCloud disclaimer.

      - - - public - getAllRegistrationForticloudDisclaimer() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /registration/forticloud/disclaimer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRegistrationForticloudDomains() - -

      - - -

      Retrieve a list of FortiCloud login domains.

      - - - public - getAllRegistrationForticloudDomains() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /registration/forticloud/domains

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterIpv4() - -

      - - -

      List all active IPv4 routing table entries.

      - - - public - getAllRouterIpv4([ $start = null ][,  $count = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return (Default for all routes).

      -
      - -
      -
      - $ip_mask - : - = null
      -
      -

      Filter: IP/netmask.

      -
      - -
      -
      - $gateway - : - = null
      -
      -

      Filter: gateway.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Filter: route type.

      -
      - -
      -
      - $interface - : - = null
      -
      -

      Filter: interface name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/ipv4

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterIpv6() - -

      - - -

      List all active IPv6 routing table entries.

      - - - public - getAllRouterIpv6([ $start = null ][,  $count = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return (Default for all routes).

      -
      - -
      -
      - $ip_mask - : - = null
      -
      -

      Filter: IP/netmask.

      -
      - -
      -
      - $gateway - : - = null
      -
      -

      Filter: gateway.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Filter: route type.

      -
      - -
      -
      - $interface - : - = null
      -
      -

      Filter: interface name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/ipv6

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterLookup() - -

      - - -

      Performs a route lookup by querying the routing table.

      - - - public - getAllRouterLookup([ $ipv6 = null ],  $destination) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $ipv6 - : - = null
      -
      -

      Perform an IPv6 lookup.

      -
      - -
      -
      - $destination - : -
      -
      -

      Destination IP/FQDN.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterLookupPolicy() - -

      - - -

      Performs a route lookup by querying the policy routing table.

      - - - public - getAllRouterLookupPolicy([ $ipv6 = null ],  $destination[,  $source = null ][,  $destination_port = null ][,  $interface_name = null ][,  $protocol_number = null ]) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $ipv6 - : - = null
      -
      -

      Perform an IPv6 lookup.

      -
      - -
      -
      - $destination - : -
      -
      -

      Destination IP/FQDN.

      -
      - -
      -
      - $source - : - = null
      -
      -

      Source IP/FQDN.

      -
      - -
      -
      - $destination_port - : - = null
      -
      -

      Destination Port.

      -
      - -
      -
      - $interface_name - : - = null
      -
      -

      Incoming Interface.

      -
      - -
      -
      - $protocol_number - : - = null
      -
      -

      IP Protocol Number.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/lookup-policy

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterPolicy() - -

      - - -

      Retrieve a list of active IPv4 policy routes.

      - - - public - getAllRouterPolicy([ $start = null ][,  $count = null ][,  $count_only = null ]) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $count_only - : - = null
      -
      -

      Returns the number of IPv4 policy routes only.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/policy

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterPolicy6() - -

      - - -

      Retrieve a list of active IPv6 policy routes.

      - - - public - getAllRouterPolicy6([ $start = null ][,  $count = null ][,  $count_only = null ]) : stdClass - -

      Access Group: netgrp.route-cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $count_only - : - = null
      -
      -

      Returns the number of IPv6 policy routes only.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/policy6

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllRouterStatistics() - -

      - - -

      Retrieve routing table statistics, including number of matched routes.

      - - - public - getAllRouterStatistics([ $ip_version = null ][,  $ip_mask = null ][,  $gateway = null ][,  $type = null ][,  $interface = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $ip_version - : - = null
      -
      -

      IP version (4|6). If not present, IPv4 and IPv6 will be returned.

      -
      - -
      -
      - $ip_mask - : - = null
      -
      -

      Filter: IP/netmask.

      -
      - -
      -
      - $gateway - : - = null
      -
      -

      Filter: gateway.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Filter: route type.

      -
      - -
      -
      - $interface - : - = null
      -
      -

      Filter: interface name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /router/statistics

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerDetectedDevice() - -

      - - -

      Retrieve a list of devices detected on all switches.

      - - - public - getAllSwitchControllerDetectedDevice() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/detected-device

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerFswFirmware() - -

      - - -

      Retrieve a list of recommended firmware for managed FortiSwitches.

      - - - public - getAllSwitchControllerFswFirmware([ $mkey = null ][,  $timeout = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: FortiSwitch ID.

      -
      - -
      -
      - $timeout - : - = null
      -
      -

      FortiGuard connection timeout (defaults to 3 seconds).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/fsw-firmware

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitch() - -

      - - -

      Retrieve statistics for configured FortiSwitches -Access Group: wifi

      - - - public - getAllSwitchControllerManagedSwitch([ $mkey = null ][,  $fsw_id = null ][,  $poe = null ][,  $port_stats = null ][,  $qos_stats = null ][,  $stp_status = null ][,  $igmp_snooping_group = null ][,  $transceiver = null ]) : stdClass - -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: FortiSwitch ID.

      -
      - -
      -
      - $fsw_id - : - = null
      -
      -

      Filter: FortiSwitch ID. mkey should be used instead.

      -
      - -
      -
      - $poe - : - = null
      -
      -

      Filter: Retrieve PoE statistics for ports of configured FortiSwitches. Port power usage is in Watt units.

      -
      - -
      -
      - $port_stats - : - = null
      -
      -

      Filter: Retrieve tx/rx statistics for ports of configured FortiSwitches.

      -
      - -
      -
      - $qos_stats - : - = null
      -
      -

      Filter: Retrieve QoS statistics for ports of configured FortiSwitches.

      -
      - -
      -
      - $stp_status - : - = null
      -
      -

      Filter: Retrieve STP status for ports of configured FortiSwitches.

      -
      - -
      -
      - $igmp_snooping_group - : - = null
      -
      -

      Filter: Retrieve IGMP Snooping group for configured FortiSwitches.

      -
      - -
      -
      - $transceiver - : - = null
      -
      -

      Filter: Retrieve transceiver information for ports of configured FortiSwitches.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitchCableStatus() - -

      - - -

      Diagnose cable information for a port. Virtual FortiSwitches and FortiLink ports are not supported.

      - - - public - getAllSwitchControllerManagedSwitchCableStatus( $mkey,  $port) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Name of managed FortiSwitch.

      -
      - -
      -
      - $port - : -
      -
      -

      Name of managed FortiSwitch port.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch/cable-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitchDhcpSnooping() - -

      - - -

      Retrieve DHCP servers monitored by FortiSwitches.

      - - - public - getAllSwitchControllerManagedSwitchDhcpSnooping() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch/dhcp-snooping

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitchFaceplateXml() - -

      - - -

      Retrieve XML for rendering FortiSwitch faceplate widget.

      - - - public - getAllSwitchControllerManagedSwitchFaceplateXml([ $mkey = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Name of managed FortiSwitch.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch/faceplate-xml

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitchHealth() - -

      - - -

      Retrieve health-check statistics for managed FortiSwitches.

      - - - public - getAllSwitchControllerManagedSwitchHealth([ $mkey = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: FortiSwitch ID.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch/health

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerManagedSwitchTransceivers() - -

      - - -

      Get a list of transceivers being used by managed FortiSwitches.

      - - - public - getAllSwitchControllerManagedSwitchTransceivers() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/managed-switch/transceivers

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerMclagIclEligiblePeer() - -

      - - -

      Find a pair of FortiSwitches that are eligible to form a tier-1 MCLAG.

      - - - public - getAllSwitchControllerMclagIclEligiblePeer( $fortilink) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $fortilink - : -
      -
      -

      FortiLink interface name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/mclag-icl/eligible-peer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSwitchControllerValidateSwitchPrefix() - -

      - - -

      Validate a FortiSwitch serial number prefix.

      - - - public - getAllSwitchControllerValidateSwitchPrefix([ $prefix = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $prefix - : - = null
      -
      -

      Prefix of FortiSwitch serial number.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /switch-controller/validate-switch-prefix

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystem3gModem() - -

      - - -

      List all 3G modems available via FortiGuard.

      - - - public - getAllSystem3gModem() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/3g-modem

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemAcquiredDns() - -

      - - -

      Retrieve a list of interfaces and their acquired DNS servers.

      - - - public - getAllSystemAcquiredDns() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/acquired-dns

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemAutomationStitchStats() - -

      - - -

      Stats for automation stitches.

      - - - public - getAllSystemAutomationStitchStats([ $mkey = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: Automation stitch name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/automation-stitch/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemAvailableCertificates() - -

      - - -

      Get available certificates.

      - - - public - getAllSystemAvailableCertificates([ $scope = null ][,  $with_remote = null ][,  $with_ca = null ][,  $with_crl = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope of certificate [vdom*|global].

      -
      - -
      -
      - $with_remote - : - = null
      -
      -

      Include remote certificates.

      -
      - -
      -
      - $with_ca - : - = null
      -
      -

      Include certificate authorities.

      -
      - -
      -
      - $with_crl - : - = null
      -
      -

      Include certificate revocation lists.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/available-certificates

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemAvailableInterfaces() - -

      - - -

      Retrieve a list of all interfaces along with some meta information regarding their availability.

      - - - public - getAllSystemAvailableInterfaces([ $view_type = null ][,  $scope = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $view_type - : - = null
      -
      -

      Optionally include additional information for interfaces. This parameter can be repeated multiple times. 'poe': Includes PoE information for supported ports (DEPRECATED in 6.4). 'ha': Includes extra meta information useful when dealing with interfaces related to HA configuration. Interfaces that are used by an HA cluster as management interfaces are also included in this view. 'zone': Includes extra meta information for determining zone membership eligibility. 'vwp': Includes extra meta information for determining virtual wire pair eligibility. 'sdwan': Includes extra meta information for determining SD-WAN eligibility. 'switch': Includes extra meta information for determining switch eligibility. 'hard-switch': Includes extra meta information for determining hard-switch eligibility. 'limited': Includes limited information on parent interfaces that are in another VDOM. 'stat': Includes TX/RX statistics data.

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope of interface list [vdom|global]

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/available-interfaces

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemBotnet() - -

      - - -

      List all known IP-based botnet entries in FortiGuard botnet database.

      - - - public - getAllSystemBotnet([ $start = null ][,  $count = null ][,  $include_hit_only = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $include_hit_only - : - = null
      -
      -

      Include entries with hits only.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/botnet

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemBotnetDomains() - -

      - - -

      List all known domain-based botnet entries in FortiGuard botnet database.

      - - - public - getAllSystemBotnetDomains([ $start = null ][,  $count = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/botnet-domains

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemBotnetDomainsHits() - -

      - - -

      List hit botnet domains with hit count > 0.

      - - - public - getAllSystemBotnetDomainsHits() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/botnet-domains/hits

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemBotnetDomainsStat() - -

      - - -

      List statistics on domain-based botnet entries in FortiGuard botnet database.

      - - - public - getAllSystemBotnetDomainsStat() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/botnet-domains/stat

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemBotnetStat() - -

      - - -

      Retrieve statistics for FortiGuard botnet database.

      - - - public - getAllSystemBotnetStat() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/botnet/stat

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemCertificateDownload() - -

      - - -

      Download certificate.

      - - - public - getAllSystemCertificateDownload( $mkey,  $type[,  $scope = null ]) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Name of certificate.

      -
      - -
      -
      - $type - : -
      -
      -

      Type of certificate [local-cer|remote-cer|local-ca|remote-ca|local-csr|crl].

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope of certificate [vdom*|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/certificate/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemCheckPortAvailability() - -

      - - -

      Check whether a list of TCP port ranges is available for a certain service.

      - - - public - getAllSystemCheckPortAvailability( $port_ranges[,  $service = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $port_ranges - : -
      -
      -

      List of TCP port range objects to check against.

      -
      - -
      -
      - $service - : - = null
      -
      -

      The service in which the ports could be available. 'service' options are [reserved | sysglobal | webproxy | ftpproxy | sslvpn | slaprobe | fsso | ftm_push]. If 'service' is not specified, the port ranges availability is checked against all services.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/check-port-availability

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemComLogDownload() - -

      - - -

      Download com-log file (after file dump is complete).

      - - - public - getAllSystemComLogDownload() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/com-log/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemComLogUpdate() - -

      - - -

      Fetch system com-log file dump progress.

      - - - public - getAllSystemComLogUpdate() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/com-log/update

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigBackup() - -

      - - -

      Backup system config -Access Group: sysgrp.mnt

      - - - public - getAllSystemConfigBackup([ $destination = null ][,  $usb_filename = null ][,  $password = null ],  $scope[,  $vdom = null ]) : stdClass - -
      - -
      Parameters
      -
      -
      - $destination - : - = null
      -
      -

      Configuration file destination [file* | usb]

      -
      - -
      -
      - $usb_filename - : - = null
      -
      -

      When using 'usb' destination: the filename to save to on the connected USB device

      -
      - -
      -
      - $password - : - = null
      -
      -

      Password to encrypt configuration data.

      -
      - -
      -
      - $scope - : -
      -
      -

      Specify global or VDOM only backup [global | vdom].

      -
      - -
      -
      - $vdom - : - = null
      -
      -

      If 'vdom' scope specified, the name of the VDOM to backup configuration.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config/backup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigErrorLogDownload() - -

      - - -

      Download the error log of the configuration management database.

      - - - public - getAllSystemConfigErrorLogDownload() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-error-log/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigRevision() - -

      - - -

      Returns a list of system configuration revisions.

      - - - public - getAllSystemConfigRevision() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-revision

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigRevisionFile() - -

      - - -

      Download a specific configuration revision.

      - - - public - getAllSystemConfigRevisionFile([ $config_id = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $config_id - : - = null
      -
      -

      Configuration id.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-revision/file

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigRevisionInfo() - -

      - - -

      Retrieve meta information for a specific configuration revision.

      - - - public - getAllSystemConfigRevisionInfo([ $config_id = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $config_id - : - = null
      -
      -

      Configuration id.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-revision/info

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigScript() - -

      - - -

      Retrieve the information about config scripts.

      - - - public - getAllSystemConfigScript() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-script

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigSyncStatus() - -

      - - -

      Get configuration sync status of SLBC cluster master and slave.

      - - - public - getAllSystemConfigSyncStatus() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config-sync/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemConfigUsbFilelist() - -

      - - -

      List configuration files available on connected USB drive.

      - - - public - getAllSystemConfigUsbFilelist() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/config/usb-filelist

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemCsf() - -

      - - -

      Retrieve a full tree of downstream FortiGates registered to the Security Fabric.

      - - - public - getAllSystemCsf([ $scope = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve the Security Fabric tree [vdom*|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/csf

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemCsfPendingAuthorizations() - -

      - - -

      Retrieve fabric devices with pending authorizations for joining the Security Fabric. Note:- This list is currently available on Security Fabric root only.

      - - - public - getAllSystemCsfPendingAuthorizations() : stdClass - -

      Access Group: secfabgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/csf/pending-authorizations

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemCurrentAdmins() - -

      - - -

      Return a list of currently logged in administrators.

      - - - public - getAllSystemCurrentAdmins() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/current-admins

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemDebugDownload() - -

      - - -

      Download debug report for technical support.

      - - - public - getAllSystemDebugDownload() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/debug/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemDhcp() - -

      - - -

      List all DHCP and DHCPv6 leases.

      - - - public - getAllSystemDhcp([ $scope = null ][,  $ipv6 = null ][,  $interface = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve DHCP leases [vdom*|global]. Global scope is only accessible for global administrators.

      -
      - -
      -
      - $ipv6 - : - = null
      -
      -

      Include IPv6 addresses in the response.

      -
      - -
      -
      - $interface - : - = null
      -
      -

      Filter: Retrieve DHCP leases for this interface only.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/dhcp

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFirmware() - -

      - - -

      Retrieve a list of firmware images available to use for upgrade on this device.

      - - - public - getAllSystemFirmware() : stdClass - -

      Access Group: sysgrp.mnt

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/firmware

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFirmwareUpgradePaths() - -

      - - -

      Retrieve a list of supported firmware upgrade paths.

      - - - public - getAllSystemFirmwareUpgradePaths() : stdClass - -

      Access Group: sysgrp.mnt

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/firmware/upgrade-paths

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFortiguardServerInfo() - -

      - - -

      Get FortiGuard server list and information.

      - - - public - getAllSystemFortiguardServerInfo() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/fortiguard/server-info

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFortimanagerBackupDetails() - -

      - - -

      Get the properties of a FortiManager object.

      - - - public - getAllSystemFortimanagerBackupDetails( $mkey,  $datasource) : stdClass - -

      Access Group: fwgrp

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Object name.

      -
      - -
      -
      - $datasource - : -
      -
      -

      Object datasource.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/fortimanager/backup-details

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFortimanagerBackupSummary() - -

      - - -

      Get FortiManager backup summary.

      - - - public - getAllSystemFortimanagerBackupSummary() : stdClass - -

      Access Group: fwgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/fortimanager/backup-summary

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemFortimanagerStatus() - -

      - - -

      Get FortiManager status.

      - - - public - getAllSystemFortimanagerStatus() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/fortimanager/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemGlobalResources() - -

      - - -

      Retrieve current usage of global resources as well as both the default and user configured maximum values.

      - - - public - getAllSystemGlobalResources() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/global-resources

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemHaChecksums() - -

      - - -

      List of checksums for members of HA cluster.

      - - - public - getAllSystemHaChecksums() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ha-checksums

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemHaHistory() - -

      - - -

      Get HA cluster historical logs.

      - - - public - getAllSystemHaHistory() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ha-history

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemHaPeer() - -

      - - -

      Get configuration of peer(s) in HA cluster. Uptime is expressed in seconds.

      - - - public - getAllSystemHaPeer([ $serial_no = null ][,  $vcluster_id = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $serial_no - : - = null
      -
      -

      Serial number of the HA member. If not specified, fetch information for all HA members

      -
      - -
      -
      - $vcluster_id - : - = null
      -
      -

      Virtual cluster number. If not specified, fetch information for all active vclusters

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ha-peer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemHaStatistics() - -

      - - -

      List of statistics for members of HA cluster.

      - - - public - getAllSystemHaStatistics() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ha-statistics

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterface() - -

      - - -

      Retrieve statistics for all system interfaces.

      - - - public - getAllSystemInterface([ $interface_name = null ][,  $include_vlan = null ][,  $include_aggregate = null ][,  $scope = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $interface_name - : - = null
      -
      -

      Filter: interface name.

      -
      - -
      -
      - $include_vlan - : - = null
      -
      -

      Enable to include VLANs in result list.

      -
      - -
      -
      - $include_aggregate - : - = null
      -
      -

      Enable to include Aggregate interfaces in result list.

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve the interface stats from [vdom|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterfaceConnectedAdminsInfo() - -

      - - -

      Return admins info that are connected to current interface.

      - - - public - getAllSystemInterfaceConnectedAdminsInfo( $interface) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $interface - : -
      -
      -

      Interface that admins is connected through.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface-connected-admins-info

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterfaceDhcpStatus() - -

      - - -

      Retrieve the DHCP client status of an interface.

      - - - public - getAllSystemInterfaceDhcpStatus( $mkey) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      Name of the interface.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface/dhcp-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterfacePoe() - -

      - - -

      Retrieve PoE statistics for system interfaces.

      - - - public - getAllSystemInterfacePoe([ $mkey = null ][,  $scope = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: Name of the interface to fetch PoE statistics for.

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve the interface stats from [vdom|global] (default=vdom).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface/poe

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterfaceSpeedTestStatus() - -

      - - -

      Retrieve the current status of a speed-test with the results if finished.

      - - - public - getAllSystemInterfaceSpeedTestStatus( $id) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $id - : -
      -
      -

      ID of the speed test.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface/speed-test-status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemInterfaceTransceivers() - -

      - - -

      Get a list of transceivers being used by the FortiGate.

      - - - public - getAllSystemInterfaceTransceivers([ $scope = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve the transceiver information from [vdom|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/interface/transceivers

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemIpconf() - -

      - - -

      Determine if there is an IP conflict for a specific IP using ARP.

      - - - public - getAllSystemIpconf( $devs,  $ipaddr) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $devs - : -
      -
      -

      List of interfaces to check for conflict.

      -
      - -
      -
      - $ipaddr - : -
      -
      -

      IPv4 address to check for conflict.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ipconf

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemLinkMonitor() - -

      - - -

      Retrieve per-interface statistics for active link monitors.

      - - - public - getAllSystemLinkMonitor([ $mkey = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Name of link monitor.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/link-monitor

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemModem() - -

      - - -

      Retrieve statistics for internal/external configured modem.

      - - - public - getAllSystemModem() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/modem

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemNat46Ippools() - -

      - - -

      Retrieve a list of all IPv6 IP pools that are valid for NAT 46 policies.

      - - - public - getAllSystemNat46Ippools() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/nat46-ippools

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemNtpStatus() - -

      - - -

      List NTP servers status.

      - - - public - getAllSystemNtpStatus() : stdClass - -

      Access Group: netgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/ntp/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemObjectUsage() - -

      - - -

      Retrieve all objects that are currently using as well as objects that can use the given object.

      - - - public - getAllSystemObjectUsage([ $q_path = null ][,  $q_name = null ][,  $qtypes = null ][,  $scope = null ],  $mkey) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $q_path - : - = null
      -
      -

      The CMDB table's path

      -
      - -
      -
      - $q_name - : - = null
      -
      -

      The CMDB table's name

      -
      - -
      -
      - $qtypes - : - = null
      -
      -

      List of CMDB table qTypes

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope of resource [vdom|global].

      -
      - -
      -
      - $mkey - : -
      -
      -

      The mkey for the object

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/object/usage

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemResolveFqdn() - -

      - - -

      Resolves the provided FQDNs to FQDN -> IP mappings.

      - - - public - getAllSystemResolveFqdn([ $ipv6 = null ][,  $fqdn = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $ipv6 - : - = null
      -
      -

      Resolve for the AAAA record?

      -
      - -
      -
      - $fqdn - : - = null
      -
      -

      List of FQDNs to be resolved

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/resolve-fqdn

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemResourceUsage() - -

      - - -

      Retreive current and historical usage data for a provided resource.

      - - - public - getAllSystemResourceUsage([ $scope = null ][,  $resource = null ][,  $interval = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope of resource [vdom|global]. This parameter is only applicable if the FGT is in VDOM mode.

      -
      - -
      -
      - $resource - : - = null
      -
      -

      Resource to get usage data for [cpu|mem|disk|session|session6|setuprate|setuprate6|disk_lograte|faz_lograte|forticloud_lograte]. Defaults to all resources if not provided. Additionally, [npu_session|npu_session6] data is available for devices that have an NPU and [nturbo_session|nturbo_session6] data is available for NP6 devices that support NTurbo.

      -
      - -
      -
      - $interval - : - = null
      -
      -

      Time interval of resource usage [1-min|10-min|30-min|1-hour|12-hour|24-hour]. Defaults to all intervals if not provided.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/resource/usage

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemRunningProcesses() - -

      - - -

      List of running processes and their resource usage.

      - - - public - getAllSystemRunningProcesses() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/running-processes

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSandboxCloudRegions() - -

      - - -

      Retrieve a list of FortiSandbox cloud regions.

      - - - public - getAllSystemSandboxCloudRegions() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sandbox/cloud-regions

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSandboxStats() - -

      - - -

      Retrieve sandbox statistics.

      - - - public - getAllSystemSandboxStats() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sandbox/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSandboxStatus() - -

      - - -

      Retrieve sandbox status.

      - - - public - getAllSystemSandboxStatus() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sandbox/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSandboxTestConnect() - -

      - - -

      Test the connectivity of a given FortiSandbox IP.

      - - - public - getAllSystemSandboxTestConnect( $server) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $server - : -
      -
      -

      IP/FQDN of the FortiSandbox to test.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sandbox/test-connect

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSdnConnectorNsxSecurityTags() - -

      - - -

      Retrieve a list of NSX security tags for connected NSX servers.

      - - - public - getAllSystemSdnConnectorNsxSecurityTags([ $mkey = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: NSX SDN connector name.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sdn-connector/nsx-security-tags

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSdnConnectorStatus() - -

      - - -

      Retrieve connection status for SDN connectors.

      - - - public - getAllSystemSdnConnectorStatus([ $mkey = null ][,  $type = null ]) : stdClass - -

      Access Group: sysgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: SDN connector name.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Filter: SDN connector type. Ignored if mkey is specified.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sdn-connector/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSecurityRating() - -

      - - -

      Retrieve a Security Rating report result. Without ID specified, returns the most recent result.

      - - - public - getAllSystemSecurityRating([ $id = null ][,  $report_type = null ][,  $scope = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $id - : - = null
      -
      -

      Report ID.

      -
      - -
      -
      - $report_type - : - = null
      -
      -

      Report type to view, Security Report when unspecified.

      -
      - -
      -
      - $scope - : - = null
      -
      -

      Scope of the report [vdom*|global]. Global scope is only accessible for global administrators.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/security-rating

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSecurityRatingHistory() - -

      - - -

      Retrieve Security Rating history.

      - - - public - getAllSystemSecurityRatingHistory([ $report_type = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $report_type - : - = null
      -
      -

      Security Rating report history to view, view Security Report when unspecified.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/security-rating/history

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSecurityRatingLang() - -

      - - -

      Returns the requested Security Rating language mapping.

      - - - public - getAllSystemSecurityRatingLang([ $key = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $key - : - = null
      -
      -

      Requested language mapping (en, fr, big5, euc-kr, GB2312, pg, sp, x-sjis).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/security-rating/lang

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSecurityRatingStatus() - -

      - - -

      Check if a Security Rating report is currently running.

      - - - public - getAllSystemSecurityRatingStatus([ $id = null ][,  $report_type = null ][,  $progress = null ]) : stdClass - -

      Access Group: secfabgrp

      -
      - -
      Parameters
      -
      -
      - $id - : - = null
      -
      -

      Report ID.

      -
      - -
      -
      - $report_type - : - = null
      -
      -

      Report type to view, Security Report when unspecified.

      -
      - -
      -
      - $progress - : - = null
      -
      -

      Query report progress.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/security-rating/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSecurityRatingSupportedReports() - -

      - - -

      Retrieve list of report types the Security Rating package supports.

      - - - public - getAllSystemSecurityRatingSupportedReports() : stdClass - -

      Access Group: secfabgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/security-rating/supported-reports

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSensorInfo() - -

      - - -

      Retrieve system sensor status.

      - - - public - getAllSystemSensorInfo() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sensor-info

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSniffer() - -

      - - -

      Return a list of all configured packet captures.

      - - - public - getAllSystemSniffer() : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sniffer

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemSnifferDownload() - -

      - - -

      Download a stored packet capture.

      - - - public - getAllSystemSnifferDownload( $mkey) : stdClass - -

      Access Group: netgrp.packet-capture

      -
      - -
      Parameters
      -
      -
      - $mkey - : -
      -
      -

      ID of packet capture entry.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/sniffer/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemStatus() - -

      - - -

      Retrieve basic system status.

      - - - public - getAllSystemStatus() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemStorage() - -

      - - -

      Retrieve information for the non-boot disk.

      - - - public - getAllSystemStorage() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/storage

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemTime() - -

      - - -

      Gets current system time stamp.

      - - - public - getAllSystemTime() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/time

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemTimezone() - -

      - - -

      Get world timezone and daylight saving time.

      - - - public - getAllSystemTimezone() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/timezone

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemTrustedCertAuthorities() - -

      - - -

      Get trusted certifiate authorities.

      - - - public - getAllSystemTrustedCertAuthorities([ $scope = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope of certificate [vdom*|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/trusted-cert-authorities

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemUsbLog() - -

      - - -

      Retrieve information about connected USB drives, including estimated log sizes.

      - - - public - getAllSystemUsbLog() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/usb-log

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemVdomLink() - -

      - - -

      Gets a list of all NPU VDOM Links and VDOM Links.

      - - - public - getAllSystemVdomLink([ $scope = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $scope - : - = null
      -
      -

      Scope from which to retrieve the VDOM link informaton from [vdom|global].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/vdom-link

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemVdomResource() - -

      - - -

      Retrieve VDOM resource information, including CPU and memory usage.

      - - - public - getAllSystemVdomResource() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/vdom-resource

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllSystemVmInformation() - -

      - - -

      Get VM information.

      - - - public - getAllSystemVmInformation() : stdClass - -

      Access Group: sysgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /system/vm-information

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserBanned() - -

      - - -

      Return a list of all banned users by IP.

      - - - public - getAllUserBanned() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/banned

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserCollectedEmail() - -

      - - -

      List email addresses collected from captive portal.

      - - - public - getAllUserCollectedEmail([ $ipv6 = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $ipv6 - : - = null
      -
      -

      Include collected email from IPv6 users.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/collected-email

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserDetectedDevice() - -

      - - -

      Retrieve a list of detected devices.

      - - - public - getAllUserDetectedDevice([ $expand_child_macs = null ][,  $with_dhcp = null ][,  $with_endpoint = null ][,  $with_fortilink = null ][,  $with_fortiap = null ][,  $with_user = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $expand_child_macs - : - = null
      -
      -

      Include child devices as separate entries in the list.

      -
      - -
      -
      - $with_dhcp - : - = null
      -
      -

      Retrieve DHCP lease information.

      -
      - -
      -
      - $with_endpoint - : - = null
      -
      -

      Retrieve FortiClient endpoint information.

      -
      - -
      -
      - $with_fortilink - : - = null
      -
      -

      Retrieve FortiLink information.

      -
      - -
      -
      - $with_fortiap - : - = null
      -
      -

      Retrieve FortiAP information.

      -
      - -
      -
      - $with_user - : - = null
      -
      -

      Retrieve authenticated user information.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/detected-device

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserDevice() - -

      - - -

      Retrieve a list of detected devices.

      - - - public - getAllUserDevice([ $master_only = null ][,  $master_mac = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $master_only - : - = null
      -
      -

      List of master device only.

      -
      - -
      -
      - $master_mac - : - = null
      -
      -

      Filter: Master MAC of a device. Multiple entries could be returned.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/device

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserDeviceQuery() - -

      - - -

      Retrieve user devices from user device store. List all the user devices if there is no filter set.

      - - - public - getAllUserDeviceQuery([ $start = null ][,  $number = null ][,  $filters = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Number of entries to skip from the beginning.

      -
      - -
      -
      - $number - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $filters - : - = null
      -
      -

      A map of filters. Type: {"key": "value"}

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/device/query

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserFirewall() - -

      - - -

      List authenticated firewall users.

      - - - public - getAllUserFirewall([ $start = null ][,  $count = null ][,  $ipv4 = null ][,  $ipv6 = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $ipv4 - : - = null
      -
      -

      Include IPv4 user (default=true).

      -
      - -
      -
      - $ipv6 - : - = null
      -
      -

      Include IPv6 users.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/firewall

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserFortitoken() - -

      - - -

      Retrieve a map of FortiTokens and their status.

      - - - public - getAllUserFortitoken() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/fortitoken

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserFortitokenCloudStatus() - -

      - - -

      Retrieve FortiToken Cloud service status.

      - - - public - getAllUserFortitokenCloudStatus() : stdClass - -

      Access Group: authgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/fortitoken-cloud/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserFsso() - -

      - - -

      Get a list of fsso and fsso polling status.

      - - - public - getAllUserFsso([ $mkey = null ][,  $type = null ]) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $mkey - : - = null
      -
      -

      Filter: Get the status for a specific FSSO entry. type is required if this is set.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Filter: Get the status for this type of FSSO entry [fsso|fsso-polling].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/fsso

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserInfoQuery() - -

      - - -

      Query user info.

      - - - public - getAllUserInfoQuery([ $start = null ][,  $number = null ],  $filters) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Number of entries to skip from the beginning.

      -
      - -
      -
      - $number - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $filters - : -
      -
      -

      A list of filters. Type: {"type": string, "value": string}

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/info/query

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUserInfoThumbnail() - -

      - - -

      Get user info thumbnail. Returns the first match to the filter.

      - - - public - getAllUserInfoThumbnail( $filters) : stdClass - -

      Access Group: authgrp

      -
      - -
      Parameters
      -
      -
      - $filters - : -
      -
      -

      A list of filters. Type: {"type": string, "value": string}

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /user/info/thumbnail

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUtmAntivirusStats() - -

      - - -

      Retrieve antivirus scanning statistics.

      - - - public - getAllUtmAntivirusStats() : stdClass - -

      Access Group: utmgrp.antivirus

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /utm/antivirus/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUtmApplicationCategories() - -

      - - -

      Retrieve a list of application control categories.

      - - - public - getAllUtmApplicationCategories() : stdClass - -

      Access Group: any

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /utm/application-categories

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUtmAppLookup() - -

      - - -

      Query remote FortiFlow database to resolve hosts to application control entries.

      - - - public - getAllUtmAppLookup([ $hosts = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $hosts - : - = null
      -
      -

      List of hosts to resolve.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /utm/app-lookup

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUtmBlacklistedCertificates() - -

      - - -

      Retrieve a list of blacklisted SSL certificates.

      - - - public - getAllUtmBlacklistedCertificates( $start,  $count) : stdClass - -

      Access Group: fwgrp.others

      -
      - -
      Parameters
      -
      -
      - $start - : -
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : -
      -
      -

      Maximum number of entries to return. Limit is set to 2000.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /utm/blacklisted-certificates

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllUtmBlacklistedCertificatesStatistics() - -

      - - -

      Retrieve blacklisted SSL certificates statistics.

      - - - public - getAllUtmBlacklistedCertificatesStatistics() : stdClass - -

      Access Group: fwgrp.others

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /utm/blacklisted-certificates/statistics

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVirtualWanHealthCheck() - -

      - - -

      Retrieve health-check statistics for each SD-WAN link.

      - - - public - getAllVirtualWanHealthCheck() : stdClass - -

      Access Group: netgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /virtual-wan/health-check

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVirtualWanInterfaceLog() - -

      - - -

      Retrieve log of SD-WAN interface quality information.

      - - - public - getAllVirtualWanInterfaceLog([ $interface = null ][,  $since = null ][,  $seconds = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $interface - : - = null
      -
      -

      Filter: Interface name.

      -
      - -
      -
      - $since - : - = null
      -
      -

      Filter: Only return SLA logs generated since this Unix timestamp.

      -
      - -
      -
      - $seconds - : - = null
      -
      -

      Filter: Only return SLA logs generated in the last N seconds.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /virtual-wan/interface-log

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVirtualWanMembers() - -

      - - -

      Retrieve interface statistics for each SD-WAN link.

      - - - public - getAllVirtualWanMembers() : stdClass - -

      Access Group: netgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /virtual-wan/members

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVirtualWanSlaLog() - -

      - - -

      Retrieve log of SLA probe results for for each SD-WAN SLA rule.

      - - - public - getAllVirtualWanSlaLog([ $sla = null ][,  $interface = null ][,  $since = null ][,  $seconds = null ]) : stdClass - -

      Access Group: netgrp.cfg

      -
      - -
      Parameters
      -
      -
      - $sla - : - = null
      -
      -

      Filter: SLA name.

      -
      - -
      -
      - $interface - : - = null
      -
      -

      Filter: Interface name.

      -
      - -
      -
      - $since - : - = null
      -
      -

      Filter: Only return SLA logs generated since this Unix timestamp.

      -
      - -
      -
      - $seconds - : - = null
      -
      -

      Filter: Only return SLA logs generated in the last N seconds.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /virtual-wan/sla-log

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnIpsec() - -

      - - -

      Return an array of active IPsec VPNs.

      - - - public - getAllVpnIpsec([ $tunnel = null ][,  $start = null ][,  $count = null ]) : stdClass - -

      Access Group: vpngrp

      -
      - -
      Parameters
      -
      -
      - $tunnel - : - = null
      -
      -

      Filter for a specific IPsec tunnel name.

      -
      - -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ipsec

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnOcvpnMembers() - -

      - - -

      Get information on devices registered in the Overlay Controller VPN cloud assisted group.

      - - - public - getAllVpnOcvpnMembers() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ocvpn/members

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnOcvpnMeta() - -

      - - -

      Get meta information (e.g. licenses and registered members) from Overlay Controller VPN cloud service.

      - - - public - getAllVpnOcvpnMeta() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ocvpn/meta

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnOcvpnStatus() - -

      - - -

      Get the last status message from FortiCloud Overlay Controller VPN cloud service.

      - - - public - getAllVpnOcvpnStatus() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ocvpn/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnSsl() - -

      - - -

      Retrieve a list of all SSL-VPN sessions and sub-sessions.

      - - - public - getAllVpnSsl() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ssl

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllVpnSslStats() - -

      - - -

      Return statistics about the SSL-VPN.

      - - - public - getAllVpnSslStats() : stdClass - -

      Access Group: vpngrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /vpn/ssl/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWanoptHistory() - -

      - - -

      Retrieve WAN opt. statistics history.

      - - - public - getAllWanoptHistory([ $period = null ]) : stdClass - -

      Access Group: wanoptgrp

      -
      - -
      Parameters
      -
      -
      - $period - : - = null
      -
      -

      Statistics period [10-min*|hour|day|week|30-day].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wanopt/history

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWanoptPeer_stats() - -

      - - -

      Retrieve a list of WAN opt peer statistics.

      - - - public - getAllWanoptPeer_stats() : stdClass - -

      Access Group: wanoptgrp

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wanopt/peer_stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWanoptWebcache() - -

      - - -

      Retrieve webcache statistics history.

      - - - public - getAllWanoptWebcache([ $period = null ]) : stdClass - -

      Access Group: wanoptgrp

      -
      - -
      Parameters
      -
      -
      - $period - : - = null
      -
      -

      Statistics period [10-min*|hour|day|week|30-day].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wanopt/webcache

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebcacheStats() - -

      - - -

      Retrieve webcache statistics.

      - - - public - getAllWebcacheStats([ $period = null ]) : stdClass - -

      Access Group: wanoptgrp

      -
      - -
      Parameters
      -
      -
      - $period - : - = null
      -
      -

      Statistics period [10min|hour|day|month].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webcache/stats

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterCategoryQuota() - -

      - - -

      Retrieve quota usage statistics for webfilter categories.

      - - - public - getAllWebfilterCategoryQuota([ $profile = null ][,  $user = null ]) : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - -
      Parameters
      -
      -
      - $profile - : - = null
      -
      -

      Webfilter profile.

      -
      - -
      -
      - $user - : - = null
      -
      -

      User or IP (required if profile specified).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/category-quota

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterFortiguardCategories() - -

      - - -

      Return FortiGuard web filter categories.

      - - - public - getAllWebfilterFortiguardCategories([ $include_unrated = null ][,  $convert_unrated_id = null ]) : stdClass - -

      Access Group: any

      -
      - -
      Parameters
      -
      -
      - $include_unrated - : - = null
      -
      -

      Include Unrated category in result list.

      -
      - -
      -
      - $convert_unrated_id - : - = null
      -
      -

      Convert Unrated category id to the one for CLI use.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/fortiguard-categories

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterMaliciousUrls() - -

      - - -

      List all URLs in FortiSandbox malicious URL database.

      - - - public - getAllWebfilterMaliciousUrls() : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/malicious-urls

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterMaliciousUrlsStat() - -

      - - -

      Retrieve statistics for the FortiSandbox malicious URL database.

      - - - public - getAllWebfilterMaliciousUrlsStat() : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/malicious-urls/stat

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterOverride() - -

      - - -

      List all administrative and user initiated webfilter overrides.

      - - - public - getAllWebfilterOverride() : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/override

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebfilterTrustedUrls() - -

      - - -

      List all URLs in FortiGuard trusted URL database.

      - - - public - getAllWebfilterTrustedUrls() : stdClass - -

      Access Group: utmgrp.webfilter

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webfilter/trusted-urls

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebproxyPacfileDownload() - -

      - - -

      Download webproxy PAC file.

      - - - public - getAllWebproxyPacfileDownload() : stdClass - -

      Access Group: netgrp.cfg

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /webproxy/pacfile/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWebUiCustomLanguageDownload() - -

      - - -

      Download a custom language file.

      - - - public - getAllWebUiCustomLanguageDownload( $filename) : stdClass - -

      Access Group: sysgrp.mnt

      -
      - -
      Parameters
      -
      -
      - $filename - : -
      -
      -

      Name of custom language entry.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /web-ui/custom-language/download

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiAp_status() - -

      - - -

      Retrieve statistics for all managed FortiAPs.

      - - - public - getAllWifiAp_status() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/ap_status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiClient() - -

      - - -

      Retrieve a list of connected WiFi clients.

      - - - public - getAllWifiClient([ $start = null ][,  $count = null ][,  $type = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - $type - : - = null
      -
      -

      Request type [all*|fail-login].

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/client

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiEuclid() - -

      - - -

      Retrieve presence analytics statistics.

      - - - public - getAllWifiEuclid() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/euclid

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiFirmware() - -

      - - -

      Retrieve a list of current and recommended firmware for FortiAPs in use.

      - - - public - getAllWifiFirmware([ $timeout = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $timeout - : - = null
      -
      -

      FortiGuard connection timeout (defaults to 2 seconds).

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/firmware

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiInterfering_ap() - -

      - - -

      Retrieve a list of interfering APs for one FortiAP radio.

      - - - public - getAllWifiInterfering_ap([ $wtp = null ][,  $radio = null ][,  $start = null ][,  $count = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $wtp - : - = null
      -
      -

      FortiAP ID to query.

      -
      - -
      -
      - $radio - : - = null
      -
      -

      Radio ID.

      -
      - -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/interfering_ap

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiManaged_ap() - -

      - - -

      Retrieve a list of managed FortiAPs.

      - - - public - getAllWifiManaged_ap([ $wtp_id = null ][,  $incl_local = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $wtp_id - : - = null
      -
      -

      Filter: single managed FortiAP by ID.

      -
      - -
      -
      - $incl_local - : - = null
      -
      -

      Enable to include the local FortiWiFi device in the results.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/managed_ap

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiNetworkList() - -

      - - -

      When FortiWiFi is in client mode, retrieve list of local WiFi networks.

      - - - public - getAllWifiNetworkList() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/network/list

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiNetworkStatus() - -

      - - -

      When FortiWiFi is in client mode, retrieve status of currently connected WiFi network, if any.

      - - - public - getAllWifiNetworkStatus() : stdClass - -

      Access Group: wifi

      -
      - - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/network/status

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiRegionImage() - -

      - - -

      Retrieves a floorplan/region image from a configured FortiAP region.

      - - - public - getAllWifiRegionImage( $region_name) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $region_name - : -
      -
      -

      Region name to retrieve image from.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/region-image

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiRogue_ap() - -

      - - -

      Retrieve a list of detected rogue APs.

      - - - public - getAllWifiRogue_ap([ $start = null ][,  $count = null ]) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $start - : - = null
      -
      -

      Starting entry index.

      -
      - -
      -
      - $count - : - = null
      -
      -

      Maximum number of entries to return.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/rogue_ap

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiSpectrum() - -

      - - -

      Retrieve spectrum analysis information for a specific FortiAP.

      - - - public - getAllWifiSpectrum( $wtp_id) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $wtp_id - : -
      -
      -

      FortiAP ID to query.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/spectrum

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - getAllWifiVlanProbe() - -

      - - -

      Retrieve the VLAN probe results.

      - - - public - getAllWifiVlanProbe( $ap_interface,  $wtp) : stdClass - -

      Access Group: wifi

      -
      - -
      Parameters
      -
      -
      - $ap_interface - : -
      -
      -

      FortiAP interface to send the probe on.

      -
      - -
      -
      - $wtp - : -
      -
      -

      FortiAP ID.

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - route -
      -
      - -

      GET /wifi/vlan-probe

      -
      - -
      -
      - -
      Return values
      - stdClass - — -

      Return the firewall's response as an object.

      -
      - - -
      -
      -

      - listTransactions() - -

      - - -

      List all transactions.

      - - - public - listTransactions([string $vdom = null ]) : bool - -
      - -
      Parameters
      -
      -
      - $vdom - : string - = null
      -
      - -
      -
      - - - -
      Return values
      - bool - — -

      Return the firewall's response as an object. -As of version 6.4.5, this method sometimes returns unparsable JSON.

      -
      - - -
      -
      -

      - startTransaction() - -

      - - -

      Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

      - - - public - startTransaction([int $timeout = null ][, string|null $vdom = null ]) : bool - -
      - -
      Parameters
      -
      -
      - $timeout - : int - = null
      -
      -

      Transaction's timeout.

      -
      - -
      -
      - $vdom - : string|null - = null
      -
      -

      Specify the Virtual Domain from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned.

      -
      - -
      -
      - - - -
      Return values
      - bool - — -

      Return TRUE on success and FALSE on failure.

      -
      - - -
      -
      -

      - curlRequest() - -

      - - -

      Method to request the firewall's API.

      - - - protected - curlRequest(string $method, string $endpoint[, int|string $pathData = null ][, stdClass|array<string|int, mixed> $queryData = null ][, stdClass|array<string|int, mixed> $bodyData = null ][, int $timeout = null ]) : stdClass - -
      - -
      Parameters
      -
      -
      - $method - : string -
      -
      -

      HTTP method (e.g. 'GET', 'POST', 'PUT', 'DELETE' ...).

      -
      - -
      -
      - $endpoint - : string -
      -
      -

      API endpoint without the 2 first element ('rest' and API version '/api/vX'), e.g. /cmdb/router/static.

      -
      - -
      -
      - $pathData - : int|string - = null
      -
      -

      Data to be passed in the request path (only one).

      -
      - -
      -
      - $queryData - : stdClass|array<string|int, mixed> - = null
      -
      -

      Data to be passed in the request query as GET arguments.

      -
      - -
      -
      - $bodyData - : stdClass|array<string|int, mixed> - = null
      -
      -

      Data to be passed in the request body as a JSON object.

      -
      - -
      -
      - $timeout - : int - = null
      -
      - -
      -
      - - - -
      Return values
      - stdClass - — -

      Return firewall's response as a stdClass.

      -
      - - -
      -
      -

      - httpBuildCustomQuery() - -

      - - -

      Function used to build a query with params but following fortigate satndards.

      - - - private - httpBuildCustomQuery(array<string|int, mixed> $data) : string - -
      - -
      Parameters
      -
      -
      - $data - : array<string|int, mixed> -
      -
      -

      Array of data.

      -
      - -
      -
      - - - -
      Return values
      - string - — -

      Return the data encoded in a string to be passed as an URL.

      -
      - - -
      -
      -

      - login() - -

      - - -

      Login in the firewall.

      - - - private - login() : bool - -
      - - - - -
      Return values
      - bool - — -

      Return TRUE if successful or throw Exception if fails.

      -
      - - -
      -
      -

      - logout() - -

      - - -

      Logout from the firewall.

      - - - private - logout() : Return - -
      - - - - -
      Return values
      - Return - — -

      TRUE if successful, FALSE if it failed.

      -
      - - -
      -
      - -
      -
      -
      -
      -

      Search results

      - -
      -
      -
        -
        -
        -
        -
        -
        - - -
        - - - - diff --git a/docs/classes/Fortinet-FortiOSAPI-Log.html b/docs/classes/Fortinet-FortiOSAPI-Log.html index 4c95985..9301930 100644 --- a/docs/classes/Fortinet-FortiOSAPI-Log.html +++ b/docs/classes/Fortinet-FortiOSAPI-Log.html @@ -796,7 +796,7 @@

        Abort a transaction (rollback operations).

        @@ -905,7 +905,7 @@

        Commit a transaction (apply operations).

        @@ -4948,7 +4948,7 @@

        List all transactions.

        @@ -4994,7 +4994,7 @@

        Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

        @@ -5140,7 +5140,7 @@

        Function used to build a query with params but following fortigate satndards.

        @@ -5187,7 +5187,7 @@

        Login in the firewall.

        @@ -5222,7 +5222,7 @@

        Logout from the firewall.

        diff --git a/docs/classes/Fortinet-FortiOSAPI-Monitor.html b/docs/classes/Fortinet-FortiOSAPI-Monitor.html index 7d18ac0..957ae0f 100644 --- a/docs/classes/Fortinet-FortiOSAPI-Monitor.html +++ b/docs/classes/Fortinet-FortiOSAPI-Monitor.html @@ -3116,7 +3116,7 @@

        Abort a transaction (rollback operations).

        @@ -12253,7 +12253,7 @@

        Commit a transaction (apply operations).

        @@ -26325,7 +26325,7 @@

        List all transactions.

        @@ -26371,7 +26371,7 @@

        Start a transaction (Warning : Fortinet says all tables are not supported but do not indicate which one exactly).

        @@ -26517,7 +26517,7 @@

        Function used to build a query with params but following fortigate satndards.

        @@ -26564,7 +26564,7 @@

        Login in the firewall.

        @@ -26599,7 +26599,7 @@

        Logout from the firewall.

        diff --git a/docs/files/src-fortinet-fortiosapi-fortiosapicmdb.html b/docs/files/src-fortinet-fortiosapi-fortiosapicmdb.html deleted file mode 100644 index ac44c58..0000000 --- a/docs/files/src-fortinet-fortiosapi-fortiosapicmdb.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
        -

        Documentation

        - - -
        - -
        - - -
        - -
        -
        - - - - -
        -
          -
        - -
        -

        FortiOSAPICmdb.php

        - - - -

        - Interfaces, Classes and Traits - -

        - -
        - -
        FortiOSAPICmdb
        -
        FortiOS API Cmdb
        - -
        - - - - - - - -
        -
        -
        -
        -

        Search results

        - -
        -
        -
          -
          -
          -
          -
          -
          - - -
          - - - - diff --git a/docs/files/src-fortinet-fortiosapi-fortiosapilog.html b/docs/files/src-fortinet-fortiosapi-fortiosapilog.html deleted file mode 100644 index 70eaf46..0000000 --- a/docs/files/src-fortinet-fortiosapi-fortiosapilog.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
          -

          Documentation

          - - -
          - -
          - - -
          - -
          -
          - - - - -
          -
            -
          - -
          -

          FortiOSAPILog.php

          - - - -

          - Interfaces, Classes and Traits - -

          - -
          - -
          FortiOSAPILog
          -
          FortiOS API Log
          - -
          - - - - - - - -
          -
          -
          -
          -

          Search results

          - -
          -
          -
            -
            -
            -
            -
            -
            - - -
            - - - - diff --git a/docs/files/src-fortinet-fortiosapi-fortiosapimonitor.html b/docs/files/src-fortinet-fortiosapi-fortiosapimonitor.html deleted file mode 100644 index 3bf5760..0000000 --- a/docs/files/src-fortinet-fortiosapi-fortiosapimonitor.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
            -

            Documentation

            - - -
            - -
            - - -
            - -
            -
            - - - - -
            -
              -
            - -
            -

            FortiOSAPIMonitor.php

            - - - -

            - Interfaces, Classes and Traits - -

            - -
            - -
            FortiOSAPIMonitor
            -
            FortiOS API Monitor
            - -
            - - - - - - - -
            -
            -
            -
            -

            Search results

            - -
            -
            -
              -
              -
              -
              -
              -
              - - -
              - - - - diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index f0a3232..6487c23 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -25,6 +25,11 @@ Search.appendIndex( "name": "getPassword", "summary": "Getter\u0020for\u0020API\u0020autorized\u0020user\u0027s\u0020password.", "url": "classes/Fortinet-FortiOSAPI-Config.html#method_getPassword" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003AgetProxy\u0028\u0029", + "name": "getProxy", + "summary": "Getter\u0020for\u0020curl\u0020proxy\u0020string.", + "url": "classes/Fortinet-FortiOSAPI-Config.html#method_getProxy" }, { "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003AgetSSLVerifyPeer\u0028\u0029", "name": "getSSLVerifyPeer", @@ -60,6 +65,11 @@ Search.appendIndex( "name": "setTimeout", "summary": "Setter\u0020for\u0020curl\u0027s\u0020timeout\u0020in\u0020ms.", "url": "classes/Fortinet-FortiOSAPI-Config.html#method_setTimeout" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003AsetProxy\u0028\u0029", + "name": "setProxy", + "summary": "Setter\u0020for\u0020proxy\u0020connect\u0020url.", + "url": "classes/Fortinet-FortiOSAPI-Config.html#method_setProxy" }, { "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003AsetAPIVersion\u0028\u0029", "name": "setAPIVersion", @@ -80,6 +90,11 @@ Search.appendIndex( "name": "password", "summary": "", "url": "classes/Fortinet-FortiOSAPI-Config.html#property_password" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003A\u0024proxy", + "name": "proxy", + "summary": "", + "url": "classes/Fortinet-FortiOSAPI-Config.html#property_proxy" }, { "fqsen": "\\Fortinet\\FortiOSAPI\\Config\u003A\u003A\u0024timeout", "name": "timeout", @@ -100,76 +115,6 @@ Search.appendIndex( "name": "apiVersion", "summary": "", "url": "classes/Fortinet-FortiOSAPI-Config.html#property_apiVersion" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI", - "name": "FortiOSAPI", - "summary": "FortiOS\u0020API", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Constructor\u0020takes\u0020care\u0020of\u0020checking\u0020and\u0020registering\u0020firewall\u0027s\u0020data\u0020and\u0020login\u0020to\u0020the\u0020API", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method___construct" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A__destruct\u0028\u0029", - "name": "__destruct", - "summary": "Destructor\u0020takes\u0020care\u0020of\u0020logout.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method___destruct" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AcurlRequest\u0028\u0029", - "name": "curlRequest", - "summary": "Method\u0020to\u0020request\u0020the\u0020firewall\u0027s\u0020API.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_curlRequest" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AhttpBuildCustomQuery\u0028\u0029", - "name": "httpBuildCustomQuery", - "summary": "Function\u0020used\u0020to\u0020build\u0020a\u0020query\u0020with\u0020params\u0020but\u0020following\u0020fortigate\u0020satndards.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_httpBuildCustomQuery" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003Alogin\u0028\u0029", - "name": "login", - "summary": "Login\u0020in\u0020the\u0020firewall.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_login" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003Alogout\u0028\u0029", - "name": "logout", - "summary": "Logout\u0020from\u0020the\u0020firewall.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_logout" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AlistTransactions\u0028\u0029", - "name": "listTransactions", - "summary": "List\u0020all\u0020transactions.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_listTransactions" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AstartTransaction\u0028\u0029", - "name": "startTransaction", - "summary": "Start\u0020a\u0020transaction\u0020\u0028Warning\u0020\u003A\u0020Fortinet\u0020says\u0020all\u0020tables\u0020are\u0020not\u0020supported\u0020but\u0020do\u0020not\u0020indicate\u0020which\u0020one\u0020exactly\u0029.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_startTransaction" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AcommitTransaction\u0028\u0029", - "name": "commitTransaction", - "summary": "Commit\u0020a\u0020transaction\u0020\u0028apply\u0020operations\u0029.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_commitTransaction" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AabortTransaction\u0028\u0029", - "name": "abortTransaction", - "summary": "Abort\u0020a\u0020transaction\u0020\u0028rollback\u0020operations\u0029.", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_abortTransaction" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024config", - "name": "config", - "summary": "", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_config" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024session_key", - "name": "session_key", - "summary": "", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_session_key" - }, { - "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024transaction", - "name": "transaction", - "summary": "", - "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_transaction" }, { "fqsen": "\\Fortinet\\FortiOSAPI\\Configuration", "name": "Configuration", @@ -9680,6 +9625,76 @@ Search.appendIndex( "name": "addWirelessControllerWtpProfile", "summary": "Create\u0020object\u0028s\u0029\u0020in\u0020this\u0020table.", "url": "classes/Fortinet-FortiOSAPI-Configuration.html#method_addWirelessControllerWtpProfile" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI", + "name": "FortiOSAPI", + "summary": "FortiOS\u0020API", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Constructor\u0020takes\u0020care\u0020of\u0020checking\u0020and\u0020registering\u0020firewall\u0027s\u0020data\u0020and\u0020login\u0020to\u0020the\u0020API", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method___construct" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A__destruct\u0028\u0029", + "name": "__destruct", + "summary": "Destructor\u0020takes\u0020care\u0020of\u0020logout.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method___destruct" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AcurlRequest\u0028\u0029", + "name": "curlRequest", + "summary": "Method\u0020to\u0020request\u0020the\u0020firewall\u0027s\u0020API.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_curlRequest" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AhttpBuildCustomQuery\u0028\u0029", + "name": "httpBuildCustomQuery", + "summary": "Function\u0020used\u0020to\u0020build\u0020a\u0020query\u0020with\u0020params\u0020but\u0020following\u0020fortigate\u0020satndards.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_httpBuildCustomQuery" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003Alogin\u0028\u0029", + "name": "login", + "summary": "Login\u0020in\u0020the\u0020firewall.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_login" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003Alogout\u0028\u0029", + "name": "logout", + "summary": "Logout\u0020from\u0020the\u0020firewall.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_logout" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AlistTransactions\u0028\u0029", + "name": "listTransactions", + "summary": "List\u0020all\u0020transactions.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_listTransactions" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AstartTransaction\u0028\u0029", + "name": "startTransaction", + "summary": "Start\u0020a\u0020transaction\u0020\u0028Warning\u0020\u003A\u0020Fortinet\u0020says\u0020all\u0020tables\u0020are\u0020not\u0020supported\u0020but\u0020do\u0020not\u0020indicate\u0020which\u0020one\u0020exactly\u0029.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_startTransaction" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AcommitTransaction\u0028\u0029", + "name": "commitTransaction", + "summary": "Commit\u0020a\u0020transaction\u0020\u0028apply\u0020operations\u0029.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_commitTransaction" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003AabortTransaction\u0028\u0029", + "name": "abortTransaction", + "summary": "Abort\u0020a\u0020transaction\u0020\u0028rollback\u0020operations\u0029.", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#method_abortTransaction" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024config", + "name": "config", + "summary": "", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_config" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024session_key", + "name": "session_key", + "summary": "", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_session_key" + }, { + "fqsen": "\\Fortinet\\FortiOSAPI\\FortiOSAPI\u003A\u003A\u0024transaction", + "name": "transaction", + "summary": "", + "url": "classes/Fortinet-FortiOSAPI-FortiOSAPI.html#property_transaction" }, { "fqsen": "\\Fortinet\\FortiOSAPI\\Log", "name": "Log", diff --git a/docs/namespaces/fortinet-fortiosapi.html b/docs/namespaces/fortinet-fortiosapi.html index 01ff4fe..e2c026d 100644 --- a/docs/namespaces/fortinet-fortiosapi.html +++ b/docs/namespaces/fortinet-fortiosapi.html @@ -90,10 +90,10 @@

              Config
              FortiOSAPI configuration.
              -
              FortiOSAPI
              -
              FortiOS API
              Configuration
              FortiOS API Configuration
              +
              FortiOSAPI
              +
              FortiOS API
              Log
              FortiOS API Log
              Monitor
              diff --git a/docs/packages/Default.html b/docs/packages/Default.html index a317a12..2d8936d 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -89,10 +89,10 @@

              Config
              FortiOSAPI configuration.
              -
              FortiOSAPI
              -
              FortiOS API
              Configuration
              FortiOS API Configuration
              +
              FortiOSAPI
              +
              FortiOS API
              Log
              FortiOS API Log
              Monitor
              From 4f3be084a993ce21c8f98fa3a8948fd4de71eb79 Mon Sep 17 00:00:00 2001 From: Benjamin Clerc Date: Tue, 6 Jun 2023 18:32:48 +0200 Subject: [PATCH 2/2] Fixed case --- docs/classes/Fortinet-FortiOSAPI-Config.html | 4 ++-- src/Fortinet/FortiOSAPI/Config.php | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/classes/Fortinet-FortiOSAPI-Config.html b/docs/classes/Fortinet-FortiOSAPI-Config.html index a03447d..1b6d601 100644 --- a/docs/classes/Fortinet-FortiOSAPI-Config.html +++ b/docs/classes/Fortinet-FortiOSAPI-Config.html @@ -467,7 +467,7 @@

              $proxy -

              proxy url to use.

              +

              Proxy url to use.

              @@ -1048,7 +1048,7 @@

              Return values
              string — -

              proxy connect url

              +

              Proxy connect url

              diff --git a/src/Fortinet/FortiOSAPI/Config.php b/src/Fortinet/FortiOSAPI/Config.php index 826a83b..b9c11be 100644 --- a/src/Fortinet/FortiOSAPI/Config.php +++ b/src/Fortinet/FortiOSAPI/Config.php @@ -17,7 +17,7 @@ * @property string $hostname Firewall's FQDN. * @property string $username Firewall user's valid username. * @property string $password Firewall user's valid password. - * @property string $proxy proxy url to use. + * @property string $proxy Proxy url to use. * @property int $timeout Wanted HTTP requests timeout, default to 5 seconds. * @property bool $SSLVerifyPeer HTTP client ssl verify peer option. * @property int $SSLVerifyHost HTTP client ssl verify host option. @@ -88,7 +88,7 @@ public function getPassword() : string /** * Getter for curl proxy string. - * @return string proxy connect url + * @return string Proxy connect url */ public function getProxy() : string {