< Back

Set-NsxLoadBalancerPool

Sat Jan 18, 2020 9:28 pm

NAME Set-NsxLoadBalancerPool



SYNOPSIS

Modified a LoadBalancer Pool on the specified ESG.





SYNTAX

Set-NsxLoadBalancerPool [-LoadBalancerPool] <XmlElement> [-Name <String>] [-Description <String>] [-Transparent]

[-Algorithm <String>] [-Connection <PSObject>] [<CommonParameters>]





DESCRIPTION

An NSX Edge Service Gateway provides all NSX Edge services such as firewall,

NAT, DHCP, VPN, load balancing, and high availability.



The NSX Edge load balancer enables network traffic to follow multiple paths

to a specific destination. It distributes incoming service requests evenly

among multiple servers in such a way that the load distribution is

transparent to users. Load balancing thus helps in achieving optimal

resource utilization, maximizing throughput, minimizing response time, and

avoiding overload. NSX Edge provides load balancing up to Layer 7.



A pool manages load balancer distribution methods and has a service monitor

attached to it for health check parameters. Each Pool has one or more

members. Prior to creating or updating a pool to add a member, a member

spec describing the member needs to be created.



This cmdlet modified LoadBalancer Pool on the specified ESG.





PARAMETERS

-LoadBalancerPool <XmlElement>



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Transparent [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Algorithm <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <PSObject>

PowerNSX Connection object



Required? false

Position? named

Default value $defaultNSXConnection

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$MyLBPool = Get-NsxEdge Edge01 | Get-NsxLoadBalancer | Get-NsxLoadBalancerPool



$MyLBPool | Set-NsxLoadBalancerPool -Name WebPool -Description "WebServer Pool"



Update Name and Description of LoadBalancer Pool









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$MyLBPool = Get-NsxEdge Edge01 | Get-NsxLoadBalancer | Get-NsxLoadBalancerPool



$MyLBPool | Set-NsxLoadBalancerPool -Transparent



Enable transparent mode in Load Balancer Pool









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>$MyLBPool = Get-NsxEdge Edge01 | Get-NsxLoadBalancer | Get-NsxLoadBalancerPool



$MyLBPool | Set-NsxLoadBalancerPool -Transparent:$false



Disable transparent mode in Load Balancer Pool









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>$MyLBPool = Get-NsxEdge Edge01 | Get-NsxLoadBalancer | Get-NsxLoadBalancerPool



$MyLBPool | Set-NsxLoadBalancerPool -Algorithm ip-hash



Choose the algorithm emergency (round-robin, ip-hash, uri, leastconn) of Load Balancer Pool











RELATED LINKS