FortiManager icon

FortiManager

Interact with FortiManager API

Firewall → Create VIP

AI-generated

Summary

Create a VIP object on FortiManager

Inputs

  • domain (required) — Selects the API domain (e.g., pm) for the operation
  • adom (required) — Administrative Domain name where the VIP will be created
  • vipName (required) — Name of the VIP object to create
  • externalIp (required) — External IP address or range (e.g., "203.0.113.10" or "203.0.113.10-203.0.113.20")
  • mappedIp (required) — Internal/mapped IP address or range
  • additionalFields — Optional extra configuration fields for the VIP

Output shape

a single VIP object representing the created VIP

The response contains the full VIP configuration; optional fields may be omitted; failures are returned as errors

Examples

Example 1: Create a VIP for a web service

domain: pm, adom: root, vipName: web_vip, externalIp: 203.0.113.10, mappedIp: 192.168.1.10, additionalFields: {"externalInterface": "eth0", "portForward": "enable", "protocol": "tcp", "externalPort": "80", "mappedPort": "8080", "comment": "Web service"}

Discussion