F5 Networks · Schema
VirtualServer
A virtual server resource that directs client traffic to a pool of backend servers based on an IP address and port combination.
API GatewayApplication DeliveryAutomationEdge ComputingKubernetesLoad BalancingMulti-CloudNGINXSecurityWAF
Properties
| Name | Type | Description |
|---|---|---|
| kind | string | Resource type identifier. |
| name | string | Name of the virtual server resource. |
| fullPath | string | Full path including partition. |
| generation | integer | Configuration generation counter. |
| selfLink | string | Self-referencing URI for this resource. |
| addressStatus | string | Whether the virtual contributes to the operational status of the associated virtual address. |
| autoLasthop | string | Automatic last hop setting for return traffic routing. |
| cmpEnabled | string | Whether Clustered Multi-Processing (CMP) acceleration is enabled. |
| connectionLimit | integer | Maximum number of concurrent connections allowed. A value of 0 means unlimited. |
| description | string | User-defined description of the virtual server. |
| destination | string | Destination IP address and service port in the format /partition/address:port or /partition/address.port. |
| disabled | boolean | When true, the virtual server does not accept new connections. |
| enabled | boolean | When true, the virtual server accepts and processes traffic. |
| fallbackPersistence | string | Persistence profile to use when the primary persistence method fails. |
| gtmScore | integer | Score value used by Global Traffic Manager for load balancing decisions. |
| ipProtocol | string | IP protocol for the virtual server. |
| mask | string | Network mask for the destination address. Use 255.255.255.255 for host-specific virtual servers. |
| mirror | string | Whether connection and persistence mirroring is enabled for high availability failover. |
| nat64 | string | Whether NAT64 translation is enabled. |
| partition | string | Administrative partition containing this resource. |
| persist | array | Persistence profiles applied to the virtual server. |
| pool | string | Default pool for directing traffic. Specified as a full path (e.g., /Common/my_pool). |
| profiles | array | Profiles applied to the virtual server. |
| rateLimit | string | Maximum number of connections per second. A value of disabled or 0 means no limit. |
| rateLimitMode | string | Scope of rate limiting. |
| rules | array | iRules applied to the virtual server. |
| source | string | Source address filter. Only connections from this network are accepted. |
| sourcePort | string | Source port translation behavior. |
| synCookieStatus | string | Current SYN Cookie protection status. |
| translateAddress | string | Whether address translation is enabled. |
| translatePort | string | Whether port translation is enabled. |
| vlansEnabled | boolean | Whether VLAN filtering is enabled. |
| vlansDisabled | boolean | Whether the virtual server is disabled on listed VLANs. |
| vlans | array | List of VLANs on which the virtual server is enabled or disabled. |
| vsIndex | integer | System-assigned index for the virtual server. |