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

LoadBalancer

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

Represents a Neutron v2 LoadBalancer

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$name string
$description string
$adminStateUp boolean
$tenantId string
$listeners LoadBalancerListener[]
$vipAddress string
$vipSubnetId string
$id 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.

addListener (array $userOptions = array()) : LoadBalancerListener

Add a listener to this load balancer

getStats () : LoadBalancerStat

Get stats for this loadbalancer

getStatuses () : LoadBalancerStatus

Get the status tree for this loadbalancer

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 = $loadBalancer->create($userOptions);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$loadBalancer->retrieve();

View source
update()

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

Return value

void

Example code

$loadBalancer->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$loadBalancer->delete();

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

Add a listener to this load balancer

Parameters

$userOptions array

Return value

LoadBalancerListener

Example code

$loadBalancerListener = $loadBalancer->addListener($userOptions);

View source
getStats()

Get stats for this loadbalancer

Return value

LoadBalancerStat

Example code

$loadBalancerStat = $loadBalancer->getStats();

View source
getStatuses()

Get the status tree for this loadbalancer

Return value

LoadBalancerStatus

Example code

$loadBalancerStatus = $loadBalancer->getStatuses();