List virtual IPs
list_vipsLists virtual IPs, the destination NAT rules mapping external addresses and ports to internal ones on a FortiGate. Supports paging to review large VIP tables.
Instructions
List virtual IPs, which are the destination NAT rules.
A VIP maps an external address, and optionally an external port, to an internal one. FortiOS stores those addresses inline on the VIP rather than as references to address objects.
Compare count against total_available before concluding anything
about the whole table. When truncated is present this is one page.
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 VIPs 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||