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

  • Flavor
  • Image
  • Network
  • Server
  • ServerMetadata
  • VolumeAttachment
  • Overview
  • Namespace
  • Class
  • Tree

Class Network

The Network class represents a single virtual network

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Compute\Resource\Network implements OpenCloud\Networking\Resource\NetworkInterface
Namespace: OpenCloud\Compute\Resource
Located at OpenCloud/Compute/Resource/Network.php
Methods summary
public OpenCloud\Compute\Resource\Network
# __construct( OpenCloud\Compute\Service $service, string|null $id = null )

Creates a new isolated Network object

Creates a new isolated Network object

NOTE: contains hacks to recognize the Rackspace public and private networks. These are not really networks, but they show up in lists.

Parameters

$service
The compute service associated with the network
$id
The ID of the network (this handles the pseudo-networks Network::RAX_PUBLIC and Network::RAX_PRIVATE

Returns

OpenCloud\Compute\Resource\Network
Network

Overrides

OpenCloud\Common\Resource\BaseResource::__construct()
public Guzzle\Http\Message\Response
# update( array $params = array() )

Always throws an error; updates are not permitted

Always throws an error; updates are not permitted

Parameters

$params

Returns

Guzzle\Http\Message\Response
\Guzzle\Http\Message\Response

Throws

OpenCloud\Common\Exceptions\NetworkUpdateError
always

Overrides

OpenCloud\Common\Resource\PersistentResource::update()
public OpenCloud\HttpResponse
# delete( )

Deletes an isolated network

Deletes an isolated network

Returns

OpenCloud\HttpResponse
\OpenCloud\HttpResponse

Throws

NetworkDeleteError
if HTTP status is not Success

Api

Overrides

OpenCloud\Common\Resource\PersistentResource::delete()
public string
# name( )

returns the visible name (label) of the network

returns the visible name (label) of the network

Returns

string
string

Throws

NameError
NameError

Api

protected object
# createJson( )

Creates the JSON object for the Create() method

Creates the JSON object for the Create() method

Returns

object
object

Throws

RuntimeException
\RuntimeException

Overrides

OpenCloud\Common\Resource\PersistentResource::createJson()
public mixed
# getUrl( null $path = null, array $query = array() )

Rackspace Cloud Networks operates on a different URI than OpenStack Neutron. Get this resource's URL

Rackspace Cloud Networks operates on a different URI than OpenStack Neutron. Get this resource's URL

Parameters

$path
URI path to add on
$query
Query to add on

Returns

mixed
mixed

Overrides

OpenCloud\Common\Resource\BaseResource::getUrl()
public string
# getResourcePath( )

Ascertain the correct URI path.

Ascertain the correct URI path.

Returns

string
string
public string
# getId( )

Returns

string
string

Implementation of

OpenCloud\Networking\Resource\NetworkInterface::getId()
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(), create(), generateJsonPatch(), getAlias(), getUpdateablePropertiesAsArray(), noCreate(), noDelete(), noUpdate(), recursivelyAliasPropertyValue(), refresh(), refreshFromLocationUrl(), refreshFromParent(), updateJson(), waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
findLink(), getClient(), getMetadata(), getParent(), getService(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), primaryKeyField(), resourceName(), setMetadata(), setParent(), setService()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
public mixed $id
#
public mixed $label
#
public mixed $cidr
#
protected static string $json_name
#'network'
protected static string $url_resource
#'os-networksv2'
protected static string $openStackResourcePath
#'os-networks'
Properties inherited from OpenCloud\Common\Resource\BaseResource
$metadata, $parent, $service
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0