List address groups
list_address_groupsList firewall address groups and their members to inspect group membership. Check count versus total_available and truncated status before treating results as complete.
Instructions
List firewall address groups and their members.
Compare count against total_available before concluding anything
about the whole table. When truncated is present this is one page.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_address_groups"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vdom | No | Virtual domain to read. Defaults to the one configured for this target. The `vdom` field in the response names the one actually read. | |
| limit | No | Maximum groups to return. Defaults to 200, capped at 1000. | |
| offset | No | Index to start from, for paging through a large table. | |
| target | No | Which FortiGate to query. Optional when only one is configured. | |
| name_contains | No | Case-insensitive substring filter on the group name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||