Skip to content

Virtual Server

A virtual server is a logical service endpoint on a load balancer that distributes client requests to one or more backend servers, providing a single, consistent access point for applications.

The virtual server model provides the following fields:

  • name (string): The name of the virtual server
  • vip (IP Address): The IP address of the virtual server
  • port (integer, optional): The port number of the virtual server
  • protocol (string, optional): The protocol used by the virtual server. Valid choices are "TCP", "UDP", "ICMP", "SCTP", "HTTP", "HTTPS", "HTTP2", "gRPC", "QUIC", "DNS" and "ANY".
  • source_nat_pool (Prefix, optional): The source NAT pool used by the virtual server
  • source_nat_type (string, optional): The source NAT type used by the virtual server. Valid choices are "Auto", "Pool", and "Static".
  • load_balancer_type (string, optional): The method of load balancing used by the virtual server. Valid choices are "Layer 2", "Layer 4", "Layer 7", and "DNS".
  • enabled (boolean): A flag indicating whether the virtual server is enabled
  • ssl_offload (boolean): A flag indicating whether SSL offload is enabled for the virtual server
  • tenant (Tenant, optional): The tenant to which the virtual server belongs
  • health_check_monitor (HealthCheckMonitor, optional): The health check monitor used by the virtual server
  • certificate_profiles (CertificateProfile, optional): The SSL/TLS profile used by the virtual server
  • load_balancer_pool (LoadBalancerPool, optional): The load balancer pool associated with this virtual server.

The virtual server requires one of the following relationships to be set. This relationship is used to determine where the virtual server is configured and managed.

  • device (Device)
  • device_redundancy_group (DeviceRedundancyGroup)
  • virtual_chassis (VirtualChassis)
  • cloud_service (CloudService)