vCloud API - LoadBalancerService

LoadBalancerServiceType

Element:

LoadBalancerService

Type:

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents gateway load balancer service.

Since:

5.1

Schema:

network.xsd

Media type(s):

None

Extends:

NetworkServiceType

XML Representation:

<LoadBalancerService xmlns="http://www.vmware.com/vcloud/v1.5">
    <VCloudExtension required="xs:boolean"/>
    <IsEnabled> xs:boolean </IsEnabled>
    <Pool>
        <VCloudExtension required="xs:boolean"/>
        <Id> xs:string </Id>
        <Name> xs:string </Name>
        <Description> xs:string </Description>
        <ServicePort>
            <VCloudExtension required="xs:boolean"/>
            <IsEnabled> xs:boolean </IsEnabled>
            <Protocol> xs:string </Protocol>
            <Algorithm> xs:string </Algorithm>
            <Port> xs:string </Port>
            <HealthCheckPort> xs:string </HealthCheckPort>
            <HealthCheck>
                <VCloudExtension required="xs:boolean"/>
                <Mode> xs:string </Mode>
                <Uri> xs:string </Uri>
                <HealthThreshold> xs:string </HealthThreshold>
                <UnhealthThreshold> xs:string </UnhealthThreshold>
                <Interval> xs:string </Interval>
                <Timeout> xs:string </Timeout>
            </HealthCheck>
        </ServicePort>
        <Member>
            <VCloudExtension required="xs:boolean"/>
            <IpAddress> IpAddressType </IpAddress>
            <Weight> xs:string </Weight>
            <ServicePort>
                <VCloudExtension required="xs:boolean"/>
                <IsEnabled> xs:boolean </IsEnabled>
                <Protocol> xs:string </Protocol>
                <Algorithm> xs:string </Algorithm>
                <Port> xs:string </Port>
                <HealthCheckPort> xs:string </HealthCheckPort>
                <HealthCheck>
                    <VCloudExtension required="xs:boolean"/>
                    <Mode> xs:string </Mode>
                    <Uri> xs:string </Uri>
                    <HealthThreshold> xs:string </HealthThreshold>
                    <UnhealthThreshold> xs:string </UnhealthThreshold>
                    <Interval> xs:string </Interval>
                    <Timeout> xs:string </Timeout>
                </HealthCheck>
            </ServicePort>
        </Member>
        <Operational> xs:boolean </Operational>
        <ErrorDetails> xs:string </ErrorDetails>
    </Pool>
    <VirtualServer>
        <VCloudExtension required="xs:boolean"/>
        <IsEnabled> xs:boolean </IsEnabled>
        <Name> xs:string </Name>
        <Description> xs:string </Description>
        <Interface href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
            <VCloudExtension required="xs:boolean"/>
        </Interface>
        <IpAddress> IpAddressType </IpAddress>
        <ServiceProfile>
            <VCloudExtension required="xs:boolean"/>
            <IsEnabled> xs:boolean </IsEnabled>
            <Protocol> xs:string </Protocol>
            <Port> xs:string </Port>
            <Persistence>
                <VCloudExtension required="xs:boolean"/>
                <Method> xs:string </Method>
                <CookieName> xs:string </CookieName>
                <CookieMode> xs:string </CookieMode>
            </Persistence>
        </ServiceProfile>
        <Logging> xs:boolean </Logging>
        <Pool> xs:string </Pool>
        <LoadBalancerTemplates>
            <VCloudExtension required="xs:boolean"/>
            <Name> xs:string </Name>
            <Id> xs:string </Id>
        </LoadBalancerTemplates>
    </VirtualServer>
</LoadBalancerService>

Elements

Element	Type	Required	Modifiable	Since	Description
IsEnabled	boolean	No	always	5.1	Enable or disable the service using this flag
Pool	LoadBalancerPoolType	No	always	5.1	List of load balancer pools.
VCloudExtension	VCloudExtensionType	No	always	5.1	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VirtualServer	LoadBalancerVirtualServerType	No	always	5.1	List of load balancer virtual servers.