[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Introduced1 Changed2

InlineEdgeLoadBalancerVirtualServiceCommonProperties1

Properties

EntityReference

loadBalancerPoolRef Required

The Load Balancer Pool associated with this Virtual Service.

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.

EntityReference

serviceEngineGroupRef Required

The Load Balancer Service Engine Group that is assigned to the Edge Gateway. This Virtual Service will be deployed to this Service Engine Group.

boolean

enabled Required

A flag indicating whether Virtual Service is enabled or not.

EntityReference

gatewayRef Required

The Edge Gateway associated with this Virtual Service.

string

name Required

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

EntityReference

certificateRef Optional

The certificate used for SSL termination for the Virtual Service. This is required if the service port type is “HTTPS” or “L4_TLS”.

string

id Optional

The identifier of the Virtual Service in URN format

string

ipv6VirtualIpAddress Introduced Changed 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.

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.

string

description Optional

The description of the Virtual Service.

string

virtualIpAddress Changed 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.

JSON Example

Show optional properties

{
	"enabled": false,
	"gatewayRef": {},
	"loadBalancerPoolRef": {},
	"name": "string",
	"serviceEngineGroupRef": {},
	"servicePorts": [
		{
			"portStart": 0
		}
	]
}

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

vmware-cloud-director

Used By

EdgeLoadBalancerVirtualServiceCommonProperties

What's changed in v37.0?

INTRODUCED (1)

Added Properties
ipv6VirtualIpAddress

CHANGED (2)

Changed Properties
ipv6VirtualIpAddress
virtualIpAddress

InlineEdgeLoadBalancerVirtualServiceCommonProperties1

Properties

JSON Example

Used By

What's changed in v37.0?

INTRODUCED (1)

Was this page helpful?