[{"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

EdgeLoadBalancerPoolMember

Defines a member (a destination server) in a Load Balancer Pool.


Properties

string
ipAddress Required

The ip address of the Load Balancer Pool member.


string
detailedHealthMessage Optional

The non-localized detailed message on the health of the pool member.


boolean
enabled Optional

Whether the Load Balancer Pool member is enabled or not.


string
healthStatus Optional

The current health status of the pool member. Possible values are:

  • UP - The member is operational.
  • DOWN - The member is down.
  • DISABLED - The member is disabled
  • UNKNOWN - The state is unknown.


array of string
markedDownBy Optional

When the member is DOWN, the value gives the names of the health monitors that marked the member as down. If a monitor cannot be determined, the value will be UNKNOWN.


integer as int32
port Optional

The port number of the Load Balancer Pool member. If unset, the port that the client used to connect will be used.


integer as int32
ratio Optional

The ratio of selecting eligible servers in the pool.

JSON Example

{
	"ipAddress": "string"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    detailedHealthMessage:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-restricted: Visible to provider users only
    enabled:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    healthStatus:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    ipAddress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: IPV4_IP
              constraint: NetworkAddress
    markedDownBy:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    port:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    ratio:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"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
Availability
Added in 35.0
Property Of

InlineEdgeLoadBalancerPool1

Feedback

Was this page helpful?