1. class
  2. OpenStack
  3. Networking
  4. v2
  5. Models
  6. LoadBalancerPool

LoadBalancerPool

class LoadBalancerPool extends OperatorResource implements Creatable, Retrievable, Updateable, Deletable

Represents a Neutron v2 LoadBalancer pool

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$name string
$description string
$id string
$tenantId string
$protocol string
$lbAlgorithm string
$sessionPersistence array
$adminStateUp boolean
$listeners LoadBalancerListener[]
$members LoadBalancerMember[]
$healthmonitors LoadBalancerHealthMonitor[]
$healthmonitorId string
$operatingStatus string
$provisioningStatus string

Methods

create (array $userOptions) : Creatable

Create a new resource according to the configuration set in the options.

retrieve () : void

Retrieve details of the current resource from the remote API.

update () : void

Update the current resource with the configuration set out in the user options.

delete () : void

Permanently delete this resource.

addMember (array $userOptions = array())

Add a member to this pool

getMember (string $memberId) : LoadBalancerMember

Get an instance of a member

deleteMember (string $memberId)

Delete a member

addHealthMonitor (array $userOptions = array()) : LoadBalancerHealthMonitor

Add a healthmonitor to this load balancer pool

Details

View source
create(array $userOptions)

Create a new resource according to the configuration set in the options.

Parameters

$userOptions array

Return value

Creatable

Example code

$creatable = $loadBalancerPool->create($userOptions);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$loadBalancerPool->retrieve();

View source
update()

Update the current resource with the configuration set out in the user options.

Return value

void

Example code

$loadBalancerPool->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$loadBalancerPool->delete();

View source
addMember(array $userOptions = array())

Add a member to this pool

Parameters

$userOptions array

Example code

$loadBalancerPool->addMember($userOptions);

View source
getMember(string $memberId)

Get an instance of a member

Parameters

$memberId string

Return value

LoadBalancerMember

Example code

$loadBalancerMember = $loadBalancerPool->getMember($memberId);

View source
deleteMember(string $memberId)

Delete a member

Parameters

$memberId string

Example code

$loadBalancerPool->deleteMember($memberId);

View source
addHealthMonitor(array $userOptions = array())

Add a healthmonitor to this load balancer pool

Parameters

$userOptions array

Return value

LoadBalancerHealthMonitor

Example code

$loadBalancerHealthMonitor = $loadBalancerPool->addHealthMonitor($userOptions);