InlineEdgeLoadBalancerVirtualServiceCommonProperties1

InlineEdgeLoadBalancerVirtualServiceCommonProperties1

JSON Example

{
    "id": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "virtualIpAddress": "string",
    "ipv6VirtualIpAddress": "string",
    "loadBalancerPoolRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "serviceEngineGroupRef": {
        "name": "string",
        "id": "string"
    },
    "certificateRef": {
        "name": "string",
        "id": "string"
    },
    "servicePorts": [
        {
            "tcpUdpProfile": {
                "name": "string",
                "type": "string",
                "systemDefined": false
            },
            "portStart": 0,
            "portEnd": 0,
            "sslEnabled": false
        }
    ],
    "healthStatus": "string",
    "healthMessage": "string",
    "detailedHealthMessage": "string",
    "transparentModeEnabled": false,
    "nonCriticalLoggingEnabled": false
}

string

id

Optional

The identifier of the Virtual Service in URN format

string

name

Required

The name of the Virtual Service. Name is unique across all Virtual Services for an Edge Gateway.

string

description

Optional

The description of the Virtual Service.

boolean

enabled

Required

A flag indicating whether Virtual Service is enabled or not.

string

virtualIpAddress

Optional

The IPv4 virtual IP Address (VIP) of the Virtual Service if required. This IP can be an allocated IP to the Gateway from the External Network or it can be an internal IP address used for internal load balancing.

string

ipv6VirtualIpAddress

Optional

The IPv6 virtual IP Address (VIP) of the Virtual Service if required. This IP can be an allocated IP to the Gateway from the External Network or it can be an internal IP address used for internal load balancing.

EntityReference

loadBalancerPoolRef

Required

loadBalancerPoolRef

EntityReference

gatewayRef

Required

gatewayRef

EntityReference

serviceEngineGroupRef

Required

serviceEngineGroupRef

EntityReference

certificateRef

Optional

certificateRef

array of EdgeLoadBalancerServicePort

servicePorts

Required

A list of service ports supported by this Virtual Service. Multiple L4 service ports may require an Edge Gateway Load Balancer with PREMIUM feature set.

string

healthStatus

Optional

The current health status of the virtual service. Possible values are:

• UP - The virtual service is healthy.
• DOWN - The virtual service is down, inactive, or has failed.
• DISABLED - The virtual service is disabled.
• UNAVAILABLE - The virtual service is unavailable.
• PENDING - The virtual service is being creating or resources are being allocated.
• UNKNOWN - The virtual service state is unknown.

string

healthMessage

Optional

The localized message on the health of the virtual service.

string

detailedHealthMessage

Optional

The non-localized detailed message on the health of the virtual service.

boolean

transparentModeEnabled

Optional

A flag indicating whether or not Preserve Client IP is enabled for this virtual service. In order to enable Preserve Client IP on the virtual service, Transparent Mode must be enabled on the Edge Gateway.

boolean

nonCriticalLoggingEnabled

Optional

A flag indicating whether non-critical logging is active for the virtual service or not. Once activated, logs are captured for 30 minutes. At the end of this time, non-critical logging is deactivated and this flag will become false.

Used By

EdgeLoadBalancerVirtualServiceCommonProperties