1. class
  2. OpenStack
  3. Networking
  4. v2
  5. Service

Service

class Service extends AbstractService

Network v2 service for OpenStack.

Traits

OpenStack\Common\Api\OperatorTrait

Methods

createNetwork (array $options) : Network

Create a new network resource.

createNetworks (array $options) : array

Create a new network resources.

getNetwork (string $id) : Network

Retrieve a network object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Network::retrieve}.

listNetworks (array $options = array()) : Generator

List networks.

createSubnet (array $options) : Subnet

Create a new subnet resource.

createSubnets (array $options) : []Subnet

Create a new subnet resources.

getSubnet (string $id) : Subnet

Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Subnet::retrieve}.

listSubnets (array $options = array()) : Generator

List subnets.

createPort (array $options) : Port

Create a new port resource.

createPorts (array $options) : []Port

Create new port resources.

getPort (string $id) : Port

Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Port::retrieve}.

listPorts (array $options = array()) : Generator

List ports.

listQuotas () : Generator

Lists quotas for projects with non-default quota values.

getQuota (string $tenantId) : Quota

Lists quotas for a project.

getDefaultQuota (string $tenantId) : Quota

Lists default quotas for a project

listLoadBalancers () : Generator

Lists loadbalancers for projects

getLoadBalancer (string $id) : LoadBalancer

Retrieve an instance of a LoadBalancer object

createLoadBalancer (array $options) : LoadBalancer

Create a new loadbalancer resource.

listLoadBalancerListeners () : Generator

Lists loadbalancer listeners

getLoadBalancerListener (string $id) : LoadBalancerListener

Retrieve an instance of a loadbalancer listener object

createLoadBalancerListener (array $options) : LoadBalancerListener

Create a new loadbalancer Listener resource.

listLoadBalancerPools () : Generator

Lists loadbalancer pools

getLoadBalancerPool (string $id) : LoadBalancerPool

Retrieve an instance of a loadbalancer Pool object

createLoadBalancerPool (array $options) : LoadBalancerPool

Create a new loadbalancer Pool resource.

listLoadBalancerMembers (string $poolId) : Generator

Lists loadbalancer members

getLoadBalancerMember (string $poolId, string $memberId) : LoadBalancerMember

Retrieve an instance of a loadbalancer Member object

createLoadBalancerMember (array $options) : LoadBalancerMember

Create a new loadbalancer member resource.

listLoadBalancerHealthMonitors () : Generator

Lists loadbalancer healthmonitors

getLoadBalancerHealthMonitor (string $id) : LoadBalancerHealthMonitor

Retrieve an instance of a loadbalancer healthmonitor object

createLoadBalancerHealthMonitor (array $options) : LoadBalancerHealthMonitor

Create a new loadbalancer healthmonitor resource.

Details

View source
createNetwork(array $options)

Create a new network resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postNetwork}

Return value

Network

Example code

$network = $service->createNetwork($options);

View source
createNetworks(array $options)

Create a new network resources.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postNetworks}

Return value

array

Example code

$array = $service->createNetworks($options);

View source
getNetwork(string $id)

Retrieve a network object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Network::retrieve}.

Parameters

$id string

Return value

Network

Example code

$network = $service->getNetwork($id);

View source
listNetworks(array $options = array())

List networks.

Parameters

$options array {see \OpenStack\Networking\v2\Api::getNetworks}

Return value

Generator

Example code

$generator = $service->listNetworks($options);

View source
createSubnet(array $options)

Create a new subnet resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postSubnet}

Return value

Subnet

Example code

$subnet = $service->createSubnet($options);

View source
createSubnets(array $options)

Create a new subnet resources.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postSubnets}

Return value

[]Subnet

Example code

$v2 = $service->createSubnets($options);

View source
getSubnet(string $id)

Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Subnet::retrieve}.

Parameters

$id string

Return value

Subnet

Example code

$subnet = $service->getSubnet($id);

View source
listSubnets(array $options = array())

List subnets.

Parameters

$options array {see \OpenStack\Networking\v2\Api::getSubnets}

Return value

Generator

Example code

$generator = $service->listSubnets($options);

View source
createPort(array $options)

Create a new port resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postSinglePort}

Return value

Port

Example code

$port = $service->createPort($options);

View source
createPorts(array $options)

Create new port resources.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postMultiplePorts}

Return value

[]Port

Example code

$v2 = $service->createPorts($options);

View source
getPort(string $id)

Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Port::retrieve}.

Parameters

$id string

Return value

Port

Example code

$port = $service->getPort($id);

View source
listPorts(array $options = array())

List ports.

Parameters

$options array {see \OpenStack\Networking\v2\Api::getPorts}

Return value

Generator

Example code

$generator = $service->listPorts($options);

View source
listQuotas()

Lists quotas for projects with non-default quota values.

Return value

Generator

Example code

$generator = $service->listQuotas();

View source
getQuota(string $tenantId)

Lists quotas for a project.

Retrieve a quota object without calling the remote API. Any values provided in the array will populate the empty object, allowing you greater control without the expense of network transactions. To call the remote API and have the response populate the object, call {see Quota::retrieve}.

Parameters

$tenantId string

Return value

Quota

Example code

$quota = $service->getQuota($tenantId);

View source
getDefaultQuota(string $tenantId)

Lists default quotas for a project

Parameters

$tenantId string

Return value

Quota

Example code

$quota = $service->getDefaultQuota($tenantId);

View source
listLoadBalancers()

Lists loadbalancers for projects

Return value

Generator

Example code

$generator = $service->listLoadBalancers();

View source
getLoadBalancer(string $id)

Retrieve an instance of a LoadBalancer object

Parameters

$id string

Return value

LoadBalancer

Example code

$loadBalancer = $service->getLoadBalancer($id);

View source
createLoadBalancer(array $options)

Create a new loadbalancer resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postLoadBalancer}

Return value

LoadBalancer

Example code

$loadBalancer = $service->createLoadBalancer($options);

View source
listLoadBalancerListeners()

Lists loadbalancer listeners

Return value

Generator

Example code

$generator = $service->listLoadBalancerListeners();

View source
getLoadBalancerListener(string $id)

Retrieve an instance of a loadbalancer listener object

Parameters

$id string

Return value

LoadBalancerListener

Example code

$loadBalancerListener = $service->getLoadBalancerListener($id);

View source
createLoadBalancerListener(array $options)

Create a new loadbalancer Listener resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postLoadBalancerListener}

Return value

LoadBalancerListener

Example code

$loadBalancerListener = $service->createLoadBalancerListener($options);

View source
listLoadBalancerPools()

Lists loadbalancer pools

Return value

Generator

Example code

$generator = $service->listLoadBalancerPools();

View source
getLoadBalancerPool(string $id)

Retrieve an instance of a loadbalancer Pool object

Parameters

$id string

Return value

LoadBalancerPool

Example code

$loadBalancerPool = $service->getLoadBalancerPool($id);

View source
createLoadBalancerPool(array $options)

Create a new loadbalancer Pool resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postLoadBalancerPool}

Return value

LoadBalancerPool

Example code

$loadBalancerPool = $service->createLoadBalancerPool($options);

View source
listLoadBalancerMembers(string $poolId)

Lists loadbalancer members

Parameters

$poolId string

Return value

Generator

Example code

$generator = $service->listLoadBalancerMembers($poolId);

View source
getLoadBalancerMember(string $poolId, string $memberId)

Retrieve an instance of a loadbalancer Member object

Parameters

$poolId string
$memberId string

Return value

LoadBalancerMember

Example code

$loadBalancerMember = $service->getLoadBalancerMember($poolId, $memberId);

View source
createLoadBalancerMember(array $options)

Create a new loadbalancer member resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postLoadBalancerMember}

Return value

LoadBalancerMember

Example code

$loadBalancerMember = $service->createLoadBalancerMember($options);

View source
listLoadBalancerHealthMonitors()

Lists loadbalancer healthmonitors

Return value

Generator

Example code

$generator = $service->listLoadBalancerHealthMonitors();

View source
getLoadBalancerHealthMonitor(string $id)

Retrieve an instance of a loadbalancer healthmonitor object

Parameters

$id string

Return value

LoadBalancerHealthMonitor

Example code

$loadBalancerHealthMonitor = $service->getLoadBalancerHealthMonitor($id);

View source
createLoadBalancerHealthMonitor(array $options)

Create a new loadbalancer healthmonitor resource.

Parameters

$options array {see \OpenStack\Networking\v2\Api::postLoadBalancerHealthMonitor}

Return value

LoadBalancerHealthMonitor

Example code

$loadBalancerHealthMonitor = $service->createLoadBalancerHealthMonitor($options);