FortiManager

Interact with FortiManager API
Join our community

Actions3

Overview

This node integrates with the FortiManager API, specifically allowing users to retrieve firewall address objects. It is useful for network administrators who want to programmatically query and manage firewall address configurations within FortiManager. For example, you can fetch a list of IP addresses, ranges, or FQDNs configured in your firewall policies, filter them by type or name, and paginate through large sets of addresses.

Common scenarios include:

  • Auditing firewall address objects.
  • Automating synchronization of firewall addresses with other systems.
  • Filtering and extracting specific address entries for reporting or further processing.

Properties

Name Meaning
Domain The FortiManager API domain to operate on. Options: CLI, Device Manager, Policy Manager, System, Task. Default is "Policy Manager".
Additional Fields A collection of optional parameters to refine the request:
- ADOM Administrative Domain name within FortiManager (default "root").
- Filter FortiManager filter syntax to narrow down results (e.g., name==test&&type==0).
- Filter by Name Filter addresses by name, supports wildcards (*).
- Filter by Type Filter addresses by type. Options: All Types, IP/Netmask, FQDN, IP Range, Geography.
- Format Response format: Default or Expanded (expanded shows symbolic values).
- Limit Maximum number of addresses to return per page (pagination). Default is 50.
- Offset Starting offset for pagination. Default is 0.

Output

The node outputs an array of JSON objects representing firewall address entries retrieved from FortiManager. Each object corresponds to one address record and includes fields as returned by the FortiManager API, such as name, type, subnet, range, or geographic info depending on the address type.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data output.

Dependencies

  • Requires a valid API authentication token or API key credential configured in n8n to connect to FortiManager.
  • Depends on FortiManager being accessible via its API endpoints.
  • No additional external services are required beyond FortiManager itself.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems reaching the FortiManager API.
    • Incorrect domain or resource selections causing no data or errors.
    • Filters that do not match any records returning empty results.

  • Error messages:

    • Errors thrown by the node will include the message from the FortiManager API or internal execution errors.
    • If "Continue On Fail" is enabled, errors will be returned as JSON objects with an error field instead of stopping execution.

  • Resolutions:

    • Verify API credentials and permissions.
    • Check network access and FortiManager API availability.
    • Review filter syntax and ensure correct domain/resource/operation selections.
    • Enable detailed logging to diagnose issues.

Links and References

Discussion