F5 Networks · Schema

VirtualServerCreate

Request body for creating a new virtual server.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name	Type	Description
name	string	Name of the virtual server.
partition	string	Administrative partition.
destination	string	Destination address and port in /partition/address:port format.
description	string	User-defined description.
ipProtocol	string	IP protocol.
mask	string	Destination network mask.
pool	string	Default pool full path.
profiles	array	Profiles to apply.
persist	array	Persistence profiles to apply.
source	string	Source address filter.
sourcePort	string	Source port translation behavior.
translateAddress	string
translatePort	string
connectionLimit	integer
rules	array
vlans	array
vlansEnabled	boolean
vlansDisabled	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualServerCreate",
  "title": "VirtualServerCreate",
  "type": "object",
  "description": "Request body for creating a new virtual server.",
  "required": [
    "name",
    "destination"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the virtual server.",
      "example": "my_virtual_server"
    },
    "partition": {
      "type": "string",
      "description": "Administrative partition.",
      "default": "Common",
      "example": "example_value"
    },
    "destination": {
      "type": "string",
      "description": "Destination address and port in /partition/address:port format.",
      "example": "/Common/10.0.0.100:80"
    },
    "description": {
      "type": "string",
      "description": "User-defined description.",
      "example": "A sample description."
    },
    "ipProtocol": {
      "type": "string",
      "description": "IP protocol.",
      "enum": [
        "tcp",
        "udp",
        "sctp",
        "any"
      ],
      "example": "tcp"
    },
    "mask": {
      "type": "string",
      "description": "Destination network mask.",
      "example": "255.255.255.255"
    },
    "pool": {
      "type": "string",
      "description": "Default pool full path.",
      "example": "/Common/my_pool"
    },
    "profiles": {
      "type": "array",
      "description": "Profiles to apply.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "context": {
            "type": "string",
            "enum": [
              "all",
              "clientside",
              "serverside"
            ]
          }
        }
      },
      "example": []
    },
    "persist": {
      "type": "array",
      "description": "Persistence profiles to apply.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "tmDefault": {
            "type": "string",
            "enum": [
              "yes",
              "no"
            ]
          }
        }
      },
      "example": []
    },
    "source": {
      "type": "string",
      "description": "Source address filter.",
      "default": "0.0.0.0/0",
      "example": "example_value"
    },
    "sourcePort": {
      "type": "string",
      "description": "Source port translation behavior.",
      "enum": [
        "preserve",
        "preserve-strict",
        "change"
      ],
      "example": "preserve"
    },
    "translateAddress": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "translatePort": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "connectionLimit": {
      "type": "integer",
      "minimum": 0,
      "example": 10
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "vlans": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "vlansEnabled": {
      "type": "boolean",
      "example": true
    },
    "vlansDisabled": {
      "type": "boolean",
      "example": true
    }
  }
}