FortiManager icon

FortiManager

Interact with FortiManager API

Firewall → Update VIP

AI-generated

Summary

Update an existing firewall VIP object on FortiManager

Inputs

  • domain (required) — API domain (e.g., pm) to target for the operation
  • adom (required) — Administrative Domain name where the VIP resides
  • vipName (required) — Name of the VIP object to update
  • updateFields — Collection of fields defining the updates (e.g., newName, externalIp, portForward, etc.)

Output shape

an array of items representing the operation result (typically a single response object)

The array length indicates the number of returned items; on success it contains the updated VIP details. Errors are thrown unless continueOnFail is enabled.

Examples

Example 1: Update a VIP to change its external IP and enable port forwarding

{"domain":"pm","adom":"root","vipName":"vip1","updateFields":{"newName":"vip1_updated","externalIp":"203.0.113.20","portForward":"enable","protocol":"tcp","externalPort":"443","mappedPort":"8443","comment":"Updated VIP"}}

Example 2: Update a VIP with a new mapped IP and disable ARP reply

{"domain":"pm","adom":"root","vipName":"vip2","updateFields":{"mappedIp":"192.168.2.20","arpReply":"disable","comment":"Disabled ARP"}}

Example 3: Update a VIP with only a comment change

{"domain":"pm","adom":"root","vipName":"vip3","updateFields":{"comment":"New comment for VIP"}}

Discussion