Actions28
- Firewall Actions
- Get All Policies
- Get Policy
- Get Firewall Addresses
- Create Policy
- Update Policy
- Delete Policy
- Move Policy
- Clone Policy
- Create Address
- Update Address
- Delete Address
- List Services
- Create Service
- Delete Service
- List Address Groups
- Create Address Group
- Update Address Group
- Delete Address Group
- List Service Groups
- Create Service Group
- Delete Service Group
- List VIPs
- Create VIP
- Update VIP
- Delete VIP
- List IP Pools
- Create IP Pool
- Delete IP Pool
Firewall → List VIPs
AI-generatedSummary
List VIPs in a FortiManager domain
Inputs
- domain (required) — Domain of FortiManager API to operate on (e.g., pm, securityConsole, etc.)
- adom (required) — Administrative Domain name (e.g., root or a specific ADOM)
- returnAll — Whether to return all results or use pagination
- limit — Maximum number of VIP objects to return (used when Return All is disabled)
- filter — FortiManager filter syntax to restrict returned VIPs (e.g., "name==MyVIP")
Output shape
array of VIP objects
Result may be limited by limit and filtered by returnAll; pagination can affect output size.
Examples
Example 1: Retrieve all VIP entries in the Policy Manager domain
Set Domain=pm, ADOM=root, enable Return All, optional Limit omitted
Example 2: List VIPs matching a specific name
Domain=pm, ADOM=root, Filter=name==VIP-External, Return All disabled, Limit default 50
Example 3: Obtain a single VIP with pagination disabled
Domain=pm, ADOM=root, Return All disabled, Limit=1