Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • Service
  • Overview
  • Namespace
  • Class
  • Tree

Class Service

The Networking class represents the OpenNetwork Neutron service.

Neutron is a service that provides networking between devices managed by other OpenNetwork services (e.g. Compute).

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService
Extended by OpenCloud\Networking\Service
Namespace: OpenCloud\Networking
Located at OpenCloud/Networking/Service.php
Methods summary
public OpenCloud\Networking\Resource\Network
# network( string $id = null )

Returns a Network object associated with this Networking service

Returns a Network object associated with this Networking service

Parameters

$id
ID of network to retrieve

Returns

OpenCloud\Networking\Resource\Network
object
public OpenCloud\Networking\Resource\Network
# createNetwork( array $params = array() )

Creates a new Network and returns it.

Creates a new Network and returns it.

Parameters

$params
Network creation parameters.

Returns

OpenCloud\Networking\Resource\Network
Object representing created network

See

https://github.com/rackspace/php-opencloud/blob/master/docs/userguide/Networking/USERGUIDE.md#create-a-network
public OpenCloud\Common\Collection\PaginatedIterator
# createNetworks( array $networksParams = array() )

Creates multiple new Networks and returns their list.

Creates multiple new Networks and returns their list.

Parameters

$networksParams
Array of network creation parameters' arrays

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\Network
# getNetwork( string $id )

Returns a Network object associated with this Networking service

Returns a Network object associated with this Networking service

Parameters

$id
ID of network to retrieve

Returns

OpenCloud\Networking\Resource\Network
object
public OpenCloud\Common\Collection\PaginatedIterator
# listNetworks( array $params = array() )

Returns a list of networks you created

Returns a list of networks you created

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\Subnet
# subnet( string $id = null )

Returns a Subnet object associated with this Networking service

Returns a Subnet object associated with this Networking service

Parameters

$id
ID of subnet to retrieve

Returns

OpenCloud\Networking\Resource\Subnet
object
public OpenCloud\Networking\Resource\Subnet
# createSubnet( array $params = array() )

Creates a new Subnet and returns it.

Creates a new Subnet and returns it.

Parameters

$params
Subnet creation parameters.

Returns

OpenCloud\Networking\Resource\Subnet
Object representing created subnet

See

https://github.com/rackspace/php-opencloud/blob/master/docs/userguide/Networking/USERGUIDE.md#create-a-subnet
public OpenCloud\Common\Collection\PaginatedIterator
# createSubnets( array $subnetsParams = array() )

Creates multiple new Subnets and returns their list.

Creates multiple new Subnets and returns their list.

Parameters

$subnetsParams
Array of subnet creation parameters' arrays

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\Subnet
# getSubnet( string $id )

Returns a Subnet object associated with this Networking service

Returns a Subnet object associated with this Networking service

Parameters

$id
ID of subnet to retrieve

Returns

OpenCloud\Networking\Resource\Subnet
object
public OpenCloud\Common\Collection\PaginatedIterator
# listSubnets( array $params = array() )

Returns a list of subnets you created

Returns a list of subnets you created

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\Port
# port( string $id = null )

Returns a Port object associated with this Networking service

Returns a Port object associated with this Networking service

Parameters

$id
ID of port to retrieve

Returns

OpenCloud\Networking\Resource\Port
object
public OpenCloud\Networking\Resource\Port
# createPort( array $params = array() )

Creates a new Port and returns it.

Creates a new Port and returns it.

Parameters

$params
Port creation parameters.

Returns

OpenCloud\Networking\Resource\Port
Object representing created port

See

https://github.com/rackspace/php-opencloud/blob/master/docs/userguide/Networking/USERGUIDE.md#create-a-port
public OpenCloud\Common\Collection\PaginatedIterator
# createPorts( array $portsParams = array() )

Creates multiple new Ports and returns their list.

Creates multiple new Ports and returns their list.

Parameters

$portsParams
Array of port creation parameters' arrays

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\Port
# getPort( string $id )

Returns a Port object associated with this Networking service

Returns a Port object associated with this Networking service

Parameters

$id
ID of port to retrieve

Returns

OpenCloud\Networking\Resource\Port
object
public OpenCloud\Common\Collection\PaginatedIterator
# listPorts( array $params = array() )

Returns a list of ports you created

Returns a list of ports you created

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\SecurityGroup
# securityGroup( string $id = null )

Returns a SecurityGroup object associated with this Networking service

Returns a SecurityGroup object associated with this Networking service

Parameters

$id
ID of security group to retrieve

Returns

OpenCloud\Networking\Resource\SecurityGroup
object
public OpenCloud\Networking\Resource\SecurityGroup
# createSecurityGroup( array $params = array() )

Creates a new SecurityGroup and returns it.

Creates a new SecurityGroup and returns it.

Parameters

$params
SecurityGroup creation parameters.

Returns

OpenCloud\Networking\Resource\SecurityGroup
Object representing created security group

See

https://github.com/rackspace/php-opencloud/blob/master/docs/userguide/Networking/USERGUIDE.md#create-a-security-group
public OpenCloud\Networking\Resource\SecurityGroup
# getSecurityGroup( string $id )

Returns a SecurityGroup object associated with this Networking service

Returns a SecurityGroup object associated with this Networking service

Parameters

$id
ID of security group to retrieve

Returns

OpenCloud\Networking\Resource\SecurityGroup
object
public OpenCloud\Common\Collection\PaginatedIterator
# listSecurityGroups( array $params = array() )

Returns a list of security groups you created

Returns a list of security groups you created

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Networking\Resource\SecurityGroupRule
# securityGroupRule( string $id = null )

Returns a SecurityGroupRule object associated with this Networking service

Returns a SecurityGroupRule object associated with this Networking service

Parameters

$id
ID of security group rule to retrieve

Returns

OpenCloud\Networking\Resource\SecurityGroupRule
object
public OpenCloud\Networking\Resource\SecurityGroupRule
# createSecurityGroupRule( array $params = array() )

Creates a new SecurityGroupRule and returns it.

Creates a new SecurityGroupRule and returns it.

Parameters

$params
SecurityGroupRule creation parameters.

Returns

OpenCloud\Networking\Resource\SecurityGroupRule
Object representing created security group rule

See

https://github.com/rackspace/php-opencloud/blob/master/docs/userguide/Networking/USERGUIDE.md#create-a-security-group-rule
public OpenCloud\Networking\Resource\SecurityGroupRule
# getSecurityGroupRule( string $id )

Returns a SecurityGroupRule object associated with this Networking service

Returns a SecurityGroupRule object associated with this Networking service

Parameters

$id
ID of security group rule to retrieve

Returns

OpenCloud\Networking\Resource\SecurityGroupRule
object
public OpenCloud\Common\Collection\PaginatedIterator
# listSecurityGroupRules( array $params = array() )

Returns a list of security group rules you created

Returns a list of security group rules you created

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public array
# namespaces( )

Return namespaces.

Return namespaces.

Returns

array
array
Methods inherited from OpenCloud\Common\Service\CatalogService
__construct(), getBaseUrl(), getExtensions(), getName(), getRegion(), getType(), getUrl(), getUrlType(), limits()
Methods inherited from OpenCloud\Common\Service\AbstractService
collection(), getClient(), getCurrentNamespace(), getEndpoint(), getNamespaces(), getResources(), resolveResourceClass(), resource(), resourceList(), setClient(), setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_TYPE
#'network'
string DEFAULT_NAME
#'cloudNetworks'
Constants inherited from OpenCloud\Common\Service\CatalogService
DEFAULT_URL_TYPE, SUPPORTED_VERSION
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties inherited from OpenCloud\Common\Service\CatalogService
$regionless
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $endpoint, $namespaces, $resources
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0