F5 Networks · Schema

VirtualServerUpdate

Request body for updating a virtual server.

API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF

Properties

Name	Type	Description
description	string
destination	string
ipProtocol	string
mask	string
pool	string
profiles	array
persist	array
source	string
sourcePort	string
translateAddress	string
translatePort	string
connectionLimit	integer
enabled	boolean
disabled	boolean
mirror	string
rateLimit	string
rules	array
vlans	array
vlansEnabled	boolean
vlansDisabled	boolean
fallbackPersistence	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualServerUpdate",
  "title": "VirtualServerUpdate",
  "type": "object",
  "description": "Request body for updating a virtual server.",
  "properties": {
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "destination": {
      "type": "string",
      "example": "example_value"
    },
    "ipProtocol": {
      "type": "string",
      "enum": [
        "tcp",
        "udp",
        "sctp",
        "any"
      ],
      "example": "tcp"
    },
    "mask": {
      "type": "string",
      "example": "example_value"
    },
    "pool": {
      "type": "string",
      "example": "example_value"
    },
    "profiles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "context": {
            "type": "string",
            "enum": [
              "all",
              "clientside",
              "serverside"
            ]
          }
        }
      },
      "example": []
    },
    "persist": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "tmDefault": {
            "type": "string"
          }
        }
      },
      "example": []
    },
    "source": {
      "type": "string",
      "example": "example_value"
    },
    "sourcePort": {
      "type": "string",
      "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
    },
    "enabled": {
      "type": "boolean",
      "example": true
    },
    "disabled": {
      "type": "boolean",
      "example": true
    },
    "mirror": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ],
      "example": "enabled"
    },
    "rateLimit": {
      "type": "string",
      "example": "example_value"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "vlans": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "vlansEnabled": {
      "type": "boolean",
      "example": true
    },
    "vlansDisabled": {
      "type": "boolean",
      "example": true
    },
    "fallbackPersistence": {
      "type": "string",
      "example": "example_value"
    }
  }
}