How To FortiManager API?

Contents:

• 1. FMG JSON API Introduction
  • 1.1. Login to FortiManager
    • 1.1.1. Session based authentication
    • 1.1.2. Token-based authentication
    • 1.1.3. FortiManager Cloud API authentication
  • 1.2. Logout from FortiManager
  • 1.3. Managing Device Settings
    • 1.3.1. Global scope settings
    • 1.3.2. VDOM scope settings
  • 1.4. Installing Device Settings
  • 1.5. Managing Security Settings
  • 1.6. Installing Security Settings
  • 1.7. Monitoring a task
  • 1.8. Multiplexing requests
    • 1.8.1. Same JSON RPC URL
    • 1.8.2. Different JSON RPC URL
    • 1.8.3. Monitoring different elements in different ADOMs
  • 1.9. Working with symbolic (human readable) values
  • 1.10. Operations on tables, objects and attributes
    • 1.10.1. How to unset a specific attribute?
  • 1.11. Permissions
    • 1.11.1. Using a normal FortiManager administrator
• 2. The option attribute
  • 2.1. loadsub
  • 2.2. count
  • 2.3. syntax
    • 2.3.1. How to get default values?
  • 2.4. devinfo
  • 2.5. obj flags
  • 2.6. datasrc
  • 2.7. chksum
• 3. Objects Management
  • 3.1. How to reference objects when names have special characters?
  • 3.2. Metadata
    • 3.2.1. How to add a metadata?
    • 3.2.2. How to delete a metadata?
    • 3.2.3. How to assign a metadata to devices?
    • 3.2.4. How to assign metadatas at Model Device creation time?
    • 3.2.5. How to unassign a metadata?
    • 3.2.6. How to replace assigned device with another one?
    • 3.2.7. How to get the value of a metadata for a specific device/vdom?
    • 3.2.8. How to set multiple metadatas for one device?
    • 3.2.9. How to assign a global metadata?
  • 3.3. Firewall Address
    • 3.3.1. How to add a FQDN firewall address?
  • 3.4. Firewall Address Groups
    • 3.4.1. How to add a single member
    • 3.4.2. How to delete a single member
    • 3.4.3. How to delete all members?
  • 3.5. Wildcard FQDN
    • 3.5.1. How to add a wildcard FQDN?
  • 3.6. Objects default values
    • 3.6.1. How to get the default values for a firewall address?
  • 3.7. How to bulk add objects?
    • 3.7.1. params multi-plexing
    • 3.7.2. data multi-plexing
  • 3.8. Normalized Interfaces
    • 3.8.1. How to create a normalized interface?
    • 3.8.2. How to add a new per-platform mapping to an existing Normalized Interface?
    • 3.8.3. How to get the normalized interfaces with a per-device mapping set for a specific device?
    • 3.8.4. How to delete an existing per-platform mapping?
  • 3.9. How to get firewall addgrp members along with their details?
  • 3.10. How to get the full ADOM database objects syntax?
  • 3.11. Internet Service Objects
    • 3.11.1. How to get the regions that can be used in a Geographic Based Internet Service object?
    • 3.11.2. How to get the countries that can be used in a Geographic Based Internet Service object?
    • 3.11.3. How to get the cities that can be used in a Geographic Based Internet Service object?
    • 3.11.4. How to get the list of the Internet Service objects?
  • 3.12. Operations on objects
    • 3.12.1. Cloning objects
      • 3.12.1.1. How to clone a firewall address?
    • 3.12.2. Filtering objects
      • 3.12.2.1. The contain operator
      • 3.12.2.2. How to filter firewall address according to their IPs?
      • 3.12.2.3. How to get the Last Modified timestamp?
      • 3.12.2.4. How to filter on the Last Modified timestamp?
      • 3.12.2.5. The like operator
      • 3.12.2.6. How to delete multiple objects?
    • 3.12.3. Used/Unused objects
      • 3.12.3.1. How to know whether a specific object is used?
      • 3.12.3.2. How to get the list of used objects?
      • 3.12.3.3. How to get unused objects?
    • 3.12.4. Where Used
      • 3.12.4.1. How to where used from the global adom?
      • 3.12.4.2. How to where used from within a normal ADOM?
    • 3.12.5. Find duplicates objects
    • 3.12.6. Merge objects
      • 3.12.6.1. How to merge firewall addresses?
    • 3.12.7. Find and Replace
      • 3.12.7.1. How to find and replace objects in firewall policy?
    • 3.12.8. Partial installation
      • 3.12.8.1. How to install an IPS profile?
    • 3.12.9. How to check for a duplicate object name?
  • 3.13. Global ADOM
    • 3.13.1. Header/Footer IPS sensor
      • 3.13.1.1. How to create a Header/Footer IPS sensor?
      • 3.13.1.2. How to delete Header/Footer IPS sensor?
      • 3.13.1.3. How to associate ADOMs to a Header/Footer IPS sensor?
      • 3.13.1.4. How to assign a Header/Footer IPS sensor?
  • 3.14. Object Revision
    • 3.14.1. How to add an object with an object revision note?
    • 3.14.2. How to update an object with an object revision note?
    • 3.14.3. How to get the revision notes for a specific object?
    • 3.14.4. How to revert to a specific object revision?
  • 3.15. How to copy objects?
  • 3.16. Per-device mapping
    • 3.16.1. Per-device mapping for firewall.address
      • 3.16.1.1. How to get per-device mapping info for a firewall address obejct?
      • 3.16.1.2. How to add a per-device mapping to a firewall address object?
      • 3.16.1.3. How to delete a per-device mapping from a firewall address object?
• 4. Security Profiles
  • 4.1. URL Filtering
    • 4.1.1. Webfilter urlfilter
      • 4.1.1.1. How to add a new entry in a webfilter.urlfilter.entries?
      • 4.1.1.2. How to delete an entry in a webfilter.urlfilter. entries?
    • 4.1.2. Web rating overrides
      • 4.1.2.1. How to add a new web rating override?
    • 4.1.3. Webfilter profile
      • 4.1.3.1. How to add a new filter in a webfilter profile?
      • 4.1.3.2. How to update a single filter in a webfilter profile?
      • 4.1.3.3. How to update a multiple categories in a webfilter profile?
      • 4.1.3.4. How to get the webfilter categories?
    • 4.1.4. The dnsfilter domain-filter object
      • 4.1.4.1. How to empty the dnsfilter.domain-filter.entries table?
  • 4.2. Application Control Management
    • 4.2.1. How to get the list of all applications?
    • 4.2.2. How to get the list of Application Categories?
    • 4.2.3. How to create a new Custom Application Signature?
  • 4.3. DLP Profile Management
    • 4.3.1. How to add a new DLP File Pattern?
    • 4.3.2. How to get DLP elements from FortiGuard DB?
      • 4.3.2.1. How to get DLP sensors from FortiGuard DB?
      • 4.3.2.2. How to get DLP dictionnaries from FortiGuard DB?
      • 4.3.2.3. How to get DLP data-type from FortiGuard DB?
  • 4.4. IPS Profiles Management
    • 4.4.1. How to add an IPS signature in an IPS profile?
    • 4.4.2. How to get list of IPS signatures?
    • 4.4.3. How to get list of IPS protocols?
    • 4.4.4. How to get list of IPS applications?
    • 4.4.5. How to get IPS Profile Usage?
  • 4.5. Virtual Patching
    • 4.5.1. How to get the Virtual Patching Signatures list?
• 5. Docker Management
  • 5.1. How to get docker status?
  • 5.2. How to upgrade a docker component?
• 6. SD-WAN Management
  • 6.1. SD-WAN Monitoring
    • 6.1.1. How to get SD-WAN Monitoring data?
  • 6.2. SD-WAN Orchestrator API
    • 6.2.1. How to get a token (ie. how to login)
    • 6.2.2. How to backup SD-WAN Orchestrator
    • 6.2.3. How to restore a SD-WAN Orchestrator
• 7. Connector Management
  • 7.1. JSON API Connector
    • 7.1.1. How to create a new JSON API Connector?
      • 7.1.1.1. Create the JSON API connector without tags
      • 7.1.1.2. Create the tags
      • 7.1.1.3. Create both using a single API request
    • 7.1.2. How to delete a JSON API Connector?
    • 7.1.3. Managing JSON API Connector tags?
      • 7.1.3.1. Add IP addresses
      • 7.1.3.2. Get IP addresses
      • 7.1.3.3. Delete IP addresses
  • 7.2. ClearPass
    • 7.2.1. TODO: How to simulate
    • 7.2.2. How to get a defined ClearPass connector?
    • 7.2.3. How to get users?
    • 7.2.4. H ow to get address groups?
    • 7.2.5. Update connector (ie. retrieve logged in users)
    • 7.2.6. How to simulate a user login via FMG JSON API?
    • 7.2.7. How to simulate a user logout via FMG JSON API?
  • 7.3. Cisco ACI
    • 7.3.1. How to get all tenants?
    • 7.3.2. How to import a tenant?
  • 7.4. SSO Agent
    • 7.4.1. How to retrieve new user.agrp?
  • 7.5. Thread Feeds Connectors
    • 7.5.1. How to define External Resources hosted in FortiManager?
• 8. Device Management
  • 8.1. How to rename a managed device?
    • 8.1.1. Using /dvmdb/device/<device>
    • 8.1.2. Using /dvmdb/adom/<adom>/device/<device>
  • 8.2. Device status
  • 8.3. How to refresh a device?
    • 8.3.1. Refresh one device
    • 8.3.2. Refresh multiple devices
  • 8.4. Device coordinates
  • 8.5. How to get the full device database syntax?
  • 8.6. How to add a real device?
  • 8.7. How to change the serial number of a managed device?
  • 8.8. How to get unauthorized devices?
  • 8.9. How to promote/authorize a real device?
  • 8.10. Model Device
    • 8.10.1. How to obtain the list of supported Model Device?
    • 8.10.2. How to create a Model Device?
      • 8.10.2.1. For a virtual appliance
      • 8.10.2.2. For a hardware appliance
    • 8.10.3. How to create a model device and add in in a group with a single request?
    • 8.10.4. How to enable the auto-link flag on a model device?
      • 8.10.4.1. Multiplexing example
    • 8.10.5. How to enable VDOM on a Model Device?
    • 8.10.6. How to enable the need_reset flag on a model device?
    • 8.10.7. How to add a model device linked to a pre-Run CLI Template?
    • 8.10.8. How to get the list of Model Devices?
  • 8.11. How to get the ADOM a device belongs to?
    • 8.11.1. How to get the ADOM a device belongs to using object master with filter?
    • 8.11.2. How to get the ADOM a device belongs to using the extra info option?
  • 8.12. How to install device settings against devices?
  • 8.13. Device Groups
    • 8.13.1. How to install device settings against a device group?
    • 8.13.2. How to create a device group?
    • 8.13.3. How to add a device in a device group?
    • 8.13.4. How to add multiple devices in a device group?
    • 8.13.5. How to add a device group into a device group?
    • 8.13.6. How to get the device group members?
    • 8.13.7. How to delete a device from a device group?
    • 8.13.8. How to delete multiple devices from a device group?
    • 8.13.9. How to delete a device group?
  • 8.14. How to delete a device?
  • 8.15. How to get device’s meta fields?
  • 8.16. How to set device’s meta fields?
  • 8.17. VDOM operations
    • 8.17.1. How to enable VDOM?
    • 8.17.2. How to create a NAT VDOM?
    • 8.17.3. How to assign a VDOM to an ADOM?
    • 8.17.4. How to create a transparent VDOM?
    • 8.17.5. How to get the interfaces assigned to a VDOM?
    • 8.17.6. How to create a VDOM link?
      • 8.17.6.1. Create the VDOM link object
      • 8.17.6.2. Set the first auto-generated system interface
      • 8.17.6.3. Set the second auto-generated system interface
    • 8.17.7. How to delete a VDOM?
    • 8.17.8. How to get the Device VDOM metafields for all VDOMs of a device?
    • 8.17.9. How to get the Device VDOM metafields for a single VDOM?
    • 8.17.10. How to set the Device VDOM metafields for multiple VDOMs of a same device?
    • 8.17.11. How to set the Device VDOM metafields for a single VDOM?
  • 8.18. How to get default settings for a particular type of device?
  • 8.19. How to get the policy package status when getting list of devices?
  • 8.20. How to get the status of a policy package assigned to a specific device?
  • 8.21. Device revisions
    • 8.21.1. How to get the list of device revisions for a particular device?
    • 8.21.2. How to get a specific device revision for a particular device?
    • 8.21.3. How to get the current device database configuration for a particular device?
    • 8.21.4. How to revert to a specific device revision?
    • 8.21.5. How to import a device revision?
  • 8.22. How to trigger a retrieve operation?
    • 8.22.1. Against a single device
    • 8.22.2. Against multiple devices
  • 8.23. Firmware upgrade
    • 8.23.1. How to get the upgrade path?
    • 8.23.2. How to get list of available firmware for a specific platform?
    • 8.23.3. How to get list of firmwares available on FortiManager drive?
    • 8.23.4. How to get list of firmwares available on FortiManager drive for a specific product?
    • 8.23.5. How to upgrade a device?
    • 8.23.6. How to get the upgrade history?
    • 8.23.7. How to get the Upgrade Report for managed devices?
  • 8.24. Certificates
    • 8.24.1. How to upload a certificate?
    • 8.24.2. How to show certificate details?
  • 8.25. Device Monitoring
    • 8.25.1. Generate an IP Pool Mapping
    • 8.25.2. How to get kernel routes from a managed fortigate device?
    • 8.25.3. How to get IPSEC tunnel statistics?
  • 8.26. How to get an install preview?
  • 8.27. How to get the platform_id, the platform_name and the ostype from a Serial Number?
  • 8.28. How to get all supported devices?
  • 8.29. Cluster
    • 8.29.1. Model HA Cluster
      • 8.29.1.1. How to create a model ha cluster?
      • 8.29.1.2. How to create a Model HA Cluster with new interfaces?
      • 8.29.1.3. How to add a Model HA Cluster with session-pick up and override enabled?
      • 8.29.1.4. How to add a Model HA Cluster with Device Blueprint and Metadata?
    • 8.29.2. How to get the cluster members?
    • 8.29.3. How to fail-over a cluster?
    • 8.29.4. How to update the serial numbers of a cluster?
    • 8.29.5. How to get cluster members status?
  • 8.30. Private Data Encryption
    • 8.30.1. How to get the private data encryption status of one device?
    • 8.30.2. How to verify a private data encryption key?
  • 8.31. FortiGate-VM
    • 8.31.1. How to upload a FortiGate-VM license?
  • 8.32. Single Pane of Glass
    • 8.32.1. How to sync a FortiManager ADOM?
      • 8.32.1.1. When a device is added
      • 8.32.1.2. When a device is deleted
  • 8.33. How to operate a Where Used?
  • 8.34. Device Blueprint
    • 8.34.1. How to get the list of metadata used by a Device Blueprint?
  • 8.35. VPN Monitor
  • 8.36. How to manage network setting?
    • 8.36.1. VLANs
      • 8.36.1.1. How to add a single VLAN?
      • 8.36.1.2. How to add multiple VLANs?
    • 8.36.2. Zones
      • 8.36.2.1. How to add members to an existing System Zone?
      • 8.36.2.2. How to delete members to an existing System Zone?
    • 8.36.3. Dynamic Routing
      • 8.36.3.1. How to add router ospf network entries?
      • 8.36.3.2. How to delete a router ospf network entry?
• 9. Policy Package Management
  • 9.1. Folders
    • 9.1.1. How to create a folder hierarchy
    • 9.1.2. How to move a folder?
    • 9.1.3. How to delete a folder?
  • 9.2. Policy Packages
    • 9.2.1. How to create a policy package?
    • 9.2.2. How to get the list of Policy Package?
    • 9.2.3. How to get a single Policy Package?
    • 9.2.4. How to get the Installation Targets of a Policy Package?
    • 9.2.5. How to assign a device to a Policy Package?
    • 9.2.6. Policy Package Installation
      • 9.2.6.1. How to install a Policy Package?
      • 9.2.6.2. How to install a Policy Package against a device?
      • 9.2.6.3. How to install a Policy Package against a Device Group?
      • 9.2.6.4. How to install a policy package located in a folder?
      • 9.2.6.5. How to install a policy package against a device’s device db only?
      • 9.2.6.6. How to install a policy package against an offline device?
      • 9.2.6.7. How to install multiple policy packages against multiple devices?
      • 9.2.6.8. How to install reinstall a policy package against a device group?
      • 9.2.6.9. How to reinstall multiple policy packages against multiple devices in parallel?
    • 9.2.7. How to copy a firewall policy?
    • 9.2.8. Scheduling operations for policy package
      • 9.2.8.1. How to schedule a policy package install?
      • 9.2.8.2. How to check for a scheduled policy package installation?
      • 9.2.8.3. How to cancel a policy package scheduled install?
    • 9.2.9. How to get the status of all policy packages in an ADOM?
    • 9.2.10. How to get the status of a specific policy package?
    • 9.2.11. How to figure out whether interface pair view are supported by a type of policies?
    • 9.2.12. How to clone a Policy Package?
    • 9.2.13. How to trigger an install preview?
    • 9.2.14. How to get the Policy Package hitcount?
    • 9.2.15. How to get the policy package checksum?
    • 9.2.16. Policy Package Revision
      • 9.2.16.1. How to get the list of changes made on a Policy Package?
      • 9.2.16.2. Can we revert a Policy Package from a specific changes?
  • 9.3. Policy Blocks
    • 9.3.1. How to create a Policy Block?
    • 9.3.2. How to add a policy in a Policy Block?
    • 9.3.3. How to insert a Policy Block in a Policy Package?
    • 9.3.4. How to where used a Policy Block?
    • 9.3.5. How to clone a firewall policy from a Policy Package to a Policy Block?
      • 9.3.5.1. Clone operation
      • 9.3.5.2. Move operation
  • 9.4. Firewall Policies
    • 9.4.1. How to get the default values for a firewall policy?
    • 9.4.2. How to add a firewall policy?
    • 9.4.3. How to delete a firewall policy?
    • 9.4.4. How to delete multiple firewall policies?
    • 9.4.5. How to purge all firewall policies?
    • 9.4.6. How to update a firewall policy?
      • 9.4.6.1. Update elements of an existing firewall policy
      • 9.4.6.2. How to update a specific field without overwriting it?
    • 9.4.7. How to move a firewall policy?
    • 9.4.8. How to insert a policy?
      • 9.4.8.1. Use the add and move operations
      • 9.4.8.2. Use the object position attribute
      • 9.4.8.3. Using the before and after attributes
    • 9.4.9. How to clone a policy?
    • 9.4.10. How to insert a section title for a firewall policy?
    • 9.4.11. How to get the section title of a policy?
    • 9.4.12. How to insert a section title for a consolidated policy?
    • 9.4.13. How to get creation and modification timestamps along with the owner of the change?
    • 9.4.14. How to get the meta-fields for policies?
    • 9.4.15. How to do a policy lookup?
    • 9.4.16. Operating the firewall policy Install On column
      • 9.4.16.1. How to get the existing values for the Install On column?
      • 9.4.16.2. How to change the Install On column?
    • 9.4.17. How to get the firewall policies along with used object definitions?
    • 9.4.18. Partial Install
      • 9.4.18.1. Legacy Partial Install API
        • 9.4.18.1.1. How to partial install a firewall policy?
        • 9.4.18.1.2. How to trigger an install preview for a partial install?
    • 9.4.19. New Partial Install API
      • 9.4.19.1. Introducing the new partial install API
      • 9.4.19.2. New Partial Install API JSON RPC payload
      • 9.4.19.3. Enable Partial Install
      • 9.4.19.4. Partial install to only install the instructed changes
        • 9.4.19.4.1. Partial install of a used/updated firewall address
        • 9.4.19.4.2. Partial install of an used/updated firewall policy with new/used/updated firewall addresses
      • 9.4.19.5. Partial install to support install + move policy
        • 9.4.19.5.1. Partial install of a new policy with new/used/updated firewall addresses
        • 9.4.19.5.2. Partial install of a deleted firewall policy
        • 9.4.19.5.3. Partial install of an updated policy
      • 9.4.19.6. Add support to preview partial install
        • 9.4.19.6.1. Preview of a partial install of an updated policy
    • 9.4.20. Firewall Policy Revision
      • 9.4.20.1. How to get list of changes mage in a firewall policy?
      • 9.4.20.2. How to revert a firewall policy from a past changes?
  • 9.5. Global Policies & objects
    • 9.5.1. How to create a global policy package?
    • 9.5.2. How to add ADOMs as global policy package member?
    • 9.5.3. How to assign a global policy package?
    • 9.5.4. How to assign a global policy package with exclusion?
    • 9.5.5. How to unassign a global policy package?
  • 9.6. How to get ADOM options?
  • 9.7. Central DNAT
    • 9.7.1. How to get central dnat policies?
    • 9.7.2. How to add central dnat policies?
  • 9.8. How to Import Policy in a policy package?
• 10. Provisioning Template Management
  • 10.1. General Introduction
    • 10.1.1. How to get all provisioning templates?
  • 10.2. How to get the controller status?
  • 10.3. Firmware Template
    • 10.3.1. Introduction
    • 10.3.2. How to assign a device?
    • 10.3.3. How to get Upgrade Reports for Firmware Template?
  • 10.4. Certificate Template
    • 10.4.1. How to create a Certificate Template?
      • 10.4.1.1. How to create an external Certificate Template?
      • 10.4.1.2. How to create a local Certificate Template?
    • 10.4.2. How to generate a certificate using a Certificate Template?
  • 10.5. System Template
    • 10.5.1. How to get list of system templates?
    • 10.5.2. How to clone a system template?
    • 10.5.3. System Template Assignment
      • 10.5.3.1. How to get assigned devices for a particular System Template?
      • 10.5.3.2. How to assign a system template to a device?
      • 10.5.3.3. How to unassign a system template from a device?
    • 10.5.4. Modify a system template content?
      • 10.5.4.1. How to add the interface widget?
      • 10.5.4.2. How to add a new Config Interface action in the interface widget?
      • 10.5.4.3. How to get the settings of the DNS widget?
      • 10.5.4.4. How to change the FortiAnalyzer setting?
    • 10.5.5. How to import a system template?
  • 10.6. FortiAP Management
    • 10.6.1. How to create a Model FortiAP with firmware enforcement?
    • 10.6.2. How to get the _platform-type?
    • 10.6.3. How to delete a FortiAP profile?
    • 10.6.4. How to get list of managed FortiAPs from ADOM DB?
    • 10.6.5. How to get a specific FortiAP profile?
    • 10.6.6. How to get details of managed FortiAP?
    • 10.6.7. How to rename a managed FAP?
  • 10.7. FortiSwitch Management
    • 10.7.1. How to add a model FortiSwich
      • 10.7.1.1. Add a Model FortiSwitch with FortiManager 7.0/7.2
      • 10.7.1.2. Add a Model FortiSwitch with FortiManager 7.4
    • 10.7.2. How to create a custom command?
    • 10.7.3. How to add a customer command to a FortiSwitch Template?
    • 10.7.4. How to assign a FortiSwitch template to a FortiSwitch?
    • 10.7.5. How to import a FortiSwitch Template from a managed device?
    • 10.7.6. How to get the default port configuration for a particular switch model?
    • 10.7.7. How to add a per-device mapping to a vlan?
    • 10.7.8. How to delete a per-device mapping from a vlan?
    • 10.7.9. How to get list of managed FortiSwitch?
    • 10.7.10. How to update a port in a FortiSwitch Template?
  • 10.8. FortiExtender
    • 10.8.1. How to add a Model FortiExtender?
    • 10.8.2. How to get the list of FortiExtender devices for one ADOM?
    • 10.8.3. How to delete a FortiExtender device?
  • 10.9. CLI Template
    • 10.9.1. How to add a cli template?
    • 10.9.2. How to delete a cli template?
    • 10.9.3. How to add a cli template group ?
    • 10.9.4. How to add a cli template in an cli template group?
    • 10.9.5. How to delete a cli template group?
    • 10.9.6. How to get the list of assigned devices for a cli template?
    • 10.9.7. How to get the list of assigned devices for a cli template group?
    • 10.9.8. How to assign a Cli Template to a device?
    • 10.9.9. How to assign a Pre-Run CLI Template to a device?
    • 10.9.10. How to assign a CLI template group to a device?
    • 10.9.11. How to assign a CLI Template (Group) to the global VDOM of a device?
    • 10.9.12. How to unassign a device from a cli template?
    • 10.9.13. How to unassign a device from a cli template group?
  • 10.10. SD-WAN Template
    • 10.10.1. SD-WAN Template Assignement
      • 10.10.1.1. How to assign a SD-WAN template to a device?
      • 10.10.1.2. How to unassign a SD-WAN template from a device?
    • 10.10.2. How to get list of SD-WAN template with assigned devices?
    • 10.10.3. How to get historical data for devices?
    • 10.10.4. TODO: SD-WAN Monitoring - Table View
    • 10.10.5. FortiManager 6.4 and older
      • 10.10.5.1. How to create an interface member?
      • 10.10.5.2. How to create an SD-WAN Template?
  • 10.11. IPsec Tunnel Template
    • 10.11.1. How to get the list of IPsec Tunnel Templates?
    • 10.11.2. How to get a specific IPsec Tunnel Template?
    • 10.11.3. How to get the tunnels of an IPsec Tunnel Template?
    • 10.11.4. How to get a specific tunnel of an IPsec Tunnel Template?
    • 10.11.5. How to create a new IPsec Tunnel Template?
    • 10.11.6. How to create a new tunnel entry in an IPsec Tunnel Template?
    • 10.11.7. How to update an existing tunnel entry in an IPsec Tunnel Interface?
    • 10.11.8. How to assign devices to an IPsec Tunnel Template?
    • 10.11.9. How to assign device groups to an IPsec Tunnel Template?
    • 10.11.10. How to unassign devices from an IPsec Tunnel Template?
    • 10.11.11. How to unassign device groups from an IPsec Tunnel Template?
    • 10.11.12. How to delete an IPsec Tunnel Template?
  • 10.12. Static Route Template
    • 10.12.1. How to update/set a static route template?
    • 10.12.2. How to get Static Route Templates?
    • 10.12.3. How to get a specific Static Route Template?
    • 10.12.4. How to assign a device to a Static Route Template?
    • 10.12.5. How to assign a device group to a Static Route Template?
    • 10.12.6. How to unassign a device from a Static Route Template?
    • 10.12.7. How to unassign a device group from a Static Route Template?
    • 10.12.8. How to create a Static Route Template from an Import from Device operation?
  • 10.13. Template Group
    • 10.13.1. How to create a Template Group?
    • 10.13.2. How to assign a Template Group to a Device Group?
  • 10.14. How to delete a Template Group?
  • 10.15. Fabric Authorization Template
    • 10.15.1. How to generate?
  • 10.16. Export/import
    • 10.16.1. How to get the list of template which can be exported?
    • 10.16.2. How to export a selected list of templates?
• 11. Operating the FortiManager’s own configuration
  • 11.1. How to get the tablesize (maximum values) information?
  • 11.2. How to get list of FortiManager Administrators?
  • 11.3. How to import local certificates?
• 12. Alternative FortiManager APIs
  • 12.1. REST API
    • 12.1.1. Getting system status
    • 12.1.2. Get list of ADOMs
  • 12.2. Using FortiManager GUI
  • 12.3. Using requests python module
  • 12.4. Using ServiceProxy python module
• 13. CLI Script management
  • 13.1. How to add a CLI Script?
  • 13.2. How to run a CLI Script against a Policy Package?
  • 13.3. How to run a CLI Script against a device?
  • 13.4. How to run a CLI Script against a Provisioning Template?
    • 13.4.1. How to run a CLI script against a SD-WAN Template?
    • 13.4.2. How to run a CLI Script against a System Template?
    • 13.4.3. How to run a CLI Script against a FortiSwitch Template?
    • 13.4.4. How to run a CLI Script against a FortiAP Profile?
  • 13.5. How To get the latest CLI Script execution output?
    • 13.5.1. For a CLI Script executed against a Policy Package
    • 13.5.2. For a CLI Script executed against a specific device
  • 13.6. How to get a specific CLI Script execution output?
  • 13.7. How to create a CLI Script Group?
• 14. ADOM management
  • 14.1. ADOM creation
    • 14.1.1. How to create an ADOM?
    • 14.1.2. How to create an ADOM with options not available in symbolic format?
    • 14.1.3. How to create an ADOM with existing managed devices?
    • 14.1.4. How to clone an ADOM?
  • 14.2. How to move a device/VDOM in a new ADOM?
  • 14.3. How to get an ADOM checksum?
  • 14.4. How to manage the ADOM and Device Display Options?
    • 14.4.1. To get the display options for a specific ADOM
    • 14.4.2. To set the display options for a specific ADOM
    • 14.4.3. To get the display options for the global ADOM
    • 14.4.4. To set the display options for the global ADOM
    • 14.4.5. To get the display options for a specific device
    • 14.4.6. To set the display options for a specific device
    • 14.4.7. To get the display options for a specific VDOM
  • 14.5. How to figure out whether an ADOM is used by some Global Policy Packages from Global ADOM?
  • 14.6. How to get the ADOM limit details?
  • 14.7. ADOM Revision
    • 14.7.1. How to get list of ADOM revisions?
    • 14.7.2. How to diff an ADOM revision with current configuration?
    • 14.7.3. How to revert an ADOM Revision?
  • 14.8. How to upgrade an ADOM?
• 15. FortiGuard Management
  • 15.1. Introduction to FortiGuard Management
  • 15.2. How to get the FMG FGD object versions?
  • 15.3. How to get the FMG upstream servers list?
  • 15.4. Firmware Management
    • 15.4.1. How to get the list of firmware images for FortiGate device?
    • 15.4.2. How to download a firmware image?
  • 15.5. How to get contracts for managed devices?
    • 15.5.1. Using /um/device/list
    • 15.5.2. Using /um/misc/dump_contract
  • 15.6. How to get the package versions for your managed devices?
  • 15.7. How to get the license status for managed devices?
  • 15.8. How to get the list of FortiGuard objects downloaded by FortiManager?
  • 15.9. How to export/import FortiGuard objects?
    • 15.9.1. How to export a FortiGuard Object?
    • 15.9.2. How to import a FortiGuard Object?
  • 15.10. How to export/import Entitlement?
  • 15.11. External Resources
    • 15.11.1. How to add a new external resource file?
      • 15.11.1.1. Using FortiManager JSON RPC API for adding a new external resource file
      • 15.11.1.2. Using REST API for adding a new external resource file
    • 15.11.2. How to delete an external resource file?
      • 15.11.2.1. Using FortiManager JSON RPC API for deleting a new external resource file
      • 15.11.2.2. Using REST API for deleting a new external resource file
• 16. QoS management
• 17. Proxying any APIs within FMG JSON API
  • 17.1. Security
  • 17.2. Replacing sys/proxy/json
  • 17.3. How to encapsulate FOS REST API call within FMG JSON RPC API?
    • 17.3.1. Add a new firewall address
    • 17.3.2. To get list of banned users
• 18. FortiManager operations
  • 18.1. How to get the FortiManager System HA Status?
  • 18.2. How to get the FortiManager get system status?
  • 18.3. How to get the FortiManager license?
  • 18.4. RBAC
    • 18.4.1. External Authentication Servers
      • 18.4.1.1. How to create a TACACS+ server?
      • 18.4.1.2. How to delete a TACACS+ server?
    • 18.4.2. Session Management
      • 18.4.2.1. How to get user session information?
  • 18.5. How to create Device Meta fields?
  • 18.6. How to create an ADOM in a managed FAZ
  • 18.7. Workspace normal mode
    • 18.7.1. Locking
      • 18.7.1.1. ADOM Lock
      • 18.7.1.2. Policy Package Lock
      • 18.7.1.3. Firewall Policy Lock
      • 18.7.1.4. Object Lock
      • 18.7.1.5. Device Lock
    • 18.7.2. Comitting changes
      • 18.7.2.1. ADOM Commit
    • 18.7.3. How to detect unsaved changes?
      • 18.7.3.1. Device commit
    • 18.7.4. Unlocking
      • 18.7.4.1. ADOM Unlock
      • 18.7.4.2. Device Unlock
    • 18.7.5. How to figure out there’s a lock?
      • 18.7.5.1. When ADOM isn’t locked
      • 18.7.5.2. When ADOM is locked
  • 18.8. Workflow mode
    • 18.8.1. How to lock an adom in workflow mode?
    • 18.8.2. How to create a workflow session?
    • 18.8.3. How to get existing sessions?
    • 18.8.4. How to save changes made in a session?
    • 18.8.5. How to discard saved changes?
    • 18.8.6. How to submit a session?
    • 18.8.7. How to delete a session?
    • 18.8.8. How to reject a session?
    • 18.8.9. How to repair a rejected session?
    • 18.8.10. How to approve a submitted session?
    • 18.8.11. How to unlock an adom in workflow mode?
    • 18.8.12. How to CLI diff?
  • 18.9. How to keep the session idle?
  • 18.10. How to get details about the connected API user?
  • 18.11. Operating the FortiManager system
    • 18.11.1. How to reboot FortiManager?
    • 18.11.2. How to backup the FortiManager?
      • 18.11.2.1. Using REST API
      • 18.11.2.2. Using FortiManager JSON RPC API
    • 18.11.3. How to restore the FortiManager?
      • 18.11.3.1. Using REST API to restore the FortiManager
      • 18.11.3.2. Using FortiManager JSON RPC API to restore FortiManager
    • 18.11.4. How to upgrade the FortiManager?
    • 18.11.5. How to get CPU, Memory and Disk usage of FortiManager?
    • 18.11.6. How to execute top or execute iotop?
      • 18.11.6.1. execute top
      • 18.11.6.2. execute iotop
• 19. Using dbcache
  • 19.1. How to get the list of interfaces for a specific device?
  • 19.2. How to get the SD-WAN configuration for all devices?
• 20. FortiManager GUI API
  • 20.1. Introduction to FortiManager GUI API
  • 20.2. How to Login?
  • 20.3. How to get the License Information
  • 20.4. NDLR: to we need this?
  • 20.5. How to Logout?
  • 20.6. How to get session information?
  • 20.7. How to get the installation log for a given revision?
  • 20.8. Some URLs caught in #0659916
  • 20.9. How to perform a device revision diff?
  • 20.10. How to get the factory default config of a managed device?
  • 20.11. How to operate the policy package check operation?
  • 20.12. How to operate a policy package diff operation?
  • 20.13. How to CSV export components from policy package?
    • 20.13.1. Trigger the CSV export task
    • 20.13.2. Download the CSV file
• 21. VPN Management
  • 21.1. SSL VPN
    • 21.1.1. How to get the default SSLVPN os-check-list?
      • 21.1.1.1. Using ADOM DB
      • 21.1.1.2. Using Device DB
  • 21.2. IPseC VPN
    • 21.2.1. How to add a member to a vpn topology?
• 22. Sub fetch operations
  • 22.1. How to reduce the amount of information returned in sub table?
  • 22.2. How to hide a specific sub-table?
  • 22.3. How to get entries when a subtable isn’t empty?
• 23. FortiManager Cloud
  • 23.1. How to create an IAM API user
  • 23.2. How to generate the access token?
  • 23.3. How to issue a FMG JSON RPC API call?
• 24. Meta-fields Management
  • 24.1. TODO
  • 24.2. Firewall Policy Meta-fields
    • 24.2.1. How to get firewall policy Meta-fields?
    • 24.2.2. How to add one firewall policy Meta-field?
    • 24.2.3. How to get firewall policy Meta-fields for one firewall policy?
    • 24.2.4. How to set a firewall policy Meta-fields?
  • 24.3. Device Meta-fields
    • 24.3.1. How to create a device Meta-fields?
  • 24.4. How to set a device Meta-field?
  • 24.5. How to set multiple device Meta-field?
• 25. CSF Management
  • 25.1. How to get the CSF for a specific ADOM?
  • 25.2. How to get a specific CSF in an ADOM?
  • 25.3. How to delete a CSF from an ADOM?
• 26. Contributors

Indices and tables

• Index

• Module Index

• Search Page