FortiManager icon

FortiManager

Interact with FortiManager API

Firewall → List IP Pools

AI-generated

Summary

List IP pools from a selected FortiManager domain within a given ADOM.

Inputs

  • domain (required) — Domain of FortiManager API to operate on (e.g., pm).
  • adom (required) — Administrative Domain name (default: 'root').
  • additionalFields — Optional collection of extra settings such as returnAll, limit, and filter.

Output shape

a list of IP pool objects

Pagination can be controlled with returnAll and limit; the result may be empty; on error a single object with an error field is returned when continueOnFail is enabled.

Examples

Example 1: List all IP pools in the default ADOM using the Policy Manager domain.

domain=pm, adom=root

Example 2: List IP pools matching a specific name with a limit of 10 results.

domain=pm, adom=root, additionalFields={filter='name==MyPool', limit=10, returnAll=false}

Discussion