FortiManagerInstall

Summary

Get firewall address objects from FortiManager using the specified domain, filters, and pagination options.

Inputs

• domain (required) — Domain of FortiManager API to operate on (e.g., pm, sys)
• additionalFields — Additional filter and options for the request, including ADOM, filter, nameFilter, typeFilter, format, limit, and offset
• adom — Administrative Domain (ADOM) name; default is "root"
• filter — FortiManager filter syntax (e.g., "name==test&&type==0")
• nameFilter — Filter addresses by name, supporting wildcards with *
• typeFilter — Filter addresses by type (e.g., ipmask, fqdn)
• format — Response format; "expanded" shows symbolic values
• limit — Maximum number of addresses to return per page
• offset — Starting offset for pagination

Output shape

a list of firewall address objects

Returns an array; pagination via limit and offset; additionalFields can extend result; errors propagate unless continueOnFail is enabled

Examples

Example 1: Retrieve all IP/Netmask addresses in the default ADOM with default pagination

domain=pm, additionalFields={adom=root, typeFilter=ipmask}

Example 2: Fetch expanded format of addresses matching a name pattern with a limit of 10

domain=pm, additionalFields={nameFilter=test*, format=expanded, limit=10}

Example 3: Apply a custom filter to return up to 50 addresses starting from offset 0

domain=pm, additionalFields={filter=name==office&&type==0, limit=50, offset=0}