• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

$QuotaSet — Property in class QuotaSet

\OpenStack\BlockStorage\v2\Api$api

$Snapshot — Property in class Snapshot

\OpenStack\BlockStorage\v2\Api$api

$Volume — Property in class Volume

$Volume — Property in class Volume

$Volume — Property in class Volume

\OpenStack\BlockStorage\v2\Api$api

$VolumeAttachment — Property in class VolumeAttachment

\OpenStack\BlockStorage\v2\Api$api

$VolumeType — Property in class VolumeType

\OpenStack\BlockStorage\v2\Api$api

$Service — Property in class Service

\OpenStack\BlockStorage\v2\Api$api

AbstractApi — Class in namespace OpenStack\Common\Api

AbstractParams — Class in namespace OpenStack\Common\Api

AbstractParams::allTenants() — Method in class AbstractParams

ApiInterface — Class in namespace OpenStack\Common\Api

All classes which implement this interface are a data representation of a remote OpenStack API.

ArrayAccessTrait — Class in namespace OpenStack\Common

Encapsulates common logic for classes which implement the SPL \ArrayAccess interface.

AuthHandler — Class in namespace OpenStack\Common\Auth

This class is responsible for three tasks:

IdentityService::authenticate() — Method in class IdentityService

Authenticates and retrieves back a token and catalog.

AbstractResource — Class in namespace OpenStack\Common\Resource

Represents a top-level abstraction of a remote API resource. Usually a resource represents a discrete entity such as a Server, Container, Load Balancer. Apart from a representation of state, a resource can also execute RESTFul operations on itself (updating, deleting, listing) or on other models.

Alias — Class in namespace OpenStack\Common\Resource

AbstractService — Class in namespace OpenStack\Common\Service

Represents the top-level abstraction of a service.

Middleware::authHandler() — Method in class Middleware

Utils::addPaths() — Method in class Utils

Add an unlimited list of paths to a given URI.

Utils::appendPath() — Method in class Utils

AvailabilityZone — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 AvailabilityZone.

$AvailabilityZone — Property in class AvailabilityZone

\OpenStack\Compute\v2\Api$api

$Flavor — Property in class Flavor

\OpenStack\Compute\v2\Api$api

$Host — Property in class Host

\OpenStack\Compute\v2\Api$api

$Hypervisor — Property in class Hypervisor

\OpenStack\Compute\v2\Api$api

$HypervisorStatistic — Property in class HypervisorStatistic

\OpenStack\Compute\v2\Api$api

$Image — Property in class Image

\OpenStack\Compute\v2\Api$api

$Keypair — Property in class Keypair

\OpenStack\Compute\v2\Api$api

$Limit — Property in class Limit

$Limit — Property in class Limit

\OpenStack\Compute\v2\Api$api

$QuotaSet — Property in class QuotaSet

\OpenStack\Compute\v2\Api$api

$Server — Property in class Server

$Server — Property in class Server

$Server — Property in class Server

\OpenStack\Compute\v2\Api$api

Server::addSecurityGroup() — Method in class Server

Add security group to a server (addSecurityGroup action)

Server::attachVolume() — Method in class Server

Attach a volume and returns volume that was attached

$Service — Property in class Service

\OpenStack\Compute\v2\Api$api

$Endpoint — Property in class Endpoint

$Service — Property in class Service

\OpenStack\Identity\v2\Api$api

Service::authenticate() — Method in class Service

Authenticates and retrieves back a token and catalog.

Assignment — Class in namespace OpenStack\Identity\v3\Models

$Catalog — Property in class Catalog

\OpenStack\Identity\v3\Api$api

$Credential — Property in class Credential

\OpenStack\Identity\v3\Api$api

$Domain — Property in class Domain

\OpenStack\Identity\v3\Api$api

$Endpoint — Property in class Endpoint

\OpenStack\Identity\v3\Api$api

$Group — Property in class Group

\OpenStack\Identity\v3\Api$api

Group::addUser() — Method in class Group

$Policy — Property in class Policy

\OpenStack\Identity\v3\Api$api

$Project — Property in class Project

\OpenStack\Identity\v3\Api$api

$Role — Property in class Role

\OpenStack\Identity\v3\Api$api

$Service — Property in class Service

\OpenStack\Identity\v3\Api$api

$Token — Property in class Token

\OpenStack\Identity\v3\Api$api

$User — Property in class User

\OpenStack\Identity\v3\Api$api

$Service — Property in class Service

\OpenStack\Identity\v3\Api$api

Service::authenticate() — Method in class Service

Authenticates and retrieves back a token and catalog.

$Image — Property in class Image

\OpenStack\Images\v2\Api$api

Image::addMember() — Method in class Image

$Member — Property in class Member

\OpenStack\Images\v2\Api$api

$Service — Property in class Service

Api$api

$Metric — Property in class Metric

$Metric — Property in class Metric

Api$api

$Resource — Property in class Resource

Api$api

$ResourceType — Property in class ResourceType

$Service — Property in class Service

Api$api

$FloatingIp — Property in class FloatingIp

Api$api

$Router — Property in class Router

$Router — Property in class Router

Api$api

Router::addInterface() — Method in class Router

$Service — Property in class Service

Api$api

$SecurityGroup — Property in class SecurityGroup

\OpenStack\Networking\v2\Extensions\SecurityGroups\Api$api

$SecurityGroupRule — Property in class SecurityGroupRule

\OpenStack\Networking\v2\Extensions\SecurityGroups\Api$api

$Service — Property in class Service

Api$api

$InterfaceAttachment — Property in class InterfaceAttachment

\OpenStack\Networking\v2\Api$api

$LoadBalancer — Property in class LoadBalancer

$LoadBalancer — Property in class LoadBalancer

Api$api

LoadBalancer::addListener() — Method in class LoadBalancer

Add a listener to this load balancer

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

Api$api

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

Api$api

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerMember — Property in class LoadBalancerMember

Api$api

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerPool — Property in class LoadBalancerPool

Api$api

LoadBalancerPool::addMember() — Method in class LoadBalancerPool

Add a member to this pool

LoadBalancerPool::addHealthMonitor() — Method in class LoadBalancerPool

Add a healthmonitor to this load balancer pool

$LoadBalancerStat — Property in class LoadBalancerStat

$LoadBalancerStat — Property in class LoadBalancerStat

Api$api

$LoadBalancerStatus — Property in class LoadBalancerStatus

Api$api

$Network — Property in class Network

$Network — Property in class Network

\OpenStack\Networking\v2\Api$api

$Port — Property in class Port

A set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address.

$Port — Property in class Port

The administrative state of the port, which is up (true) or down (false).

$Port — Property in class Port

\OpenStack\Networking\v2\Api$api

$Quota — Property in class Quota

Api$api

$Subnet — Property in class Subnet

$Subnet — Property in class Subnet

\OpenStack\Networking\v2\Api$api

$Service — Property in class Service

\OpenStack\Networking\v2\Api$api

Account — Class in namespace OpenStack\ObjectStore\v1\Models

$Account — Property in class Account

\OpenStack\ObjectStore\v1\Api$api

$Container — Property in class Container

\OpenStack\ObjectStore\v1\Api$api

$Object — Property in class Object

\OpenStack\ObjectStore\v1\Api$api

$Service — Property in class Service

\OpenStack\ObjectStore\v1\Api$api

B

$QuotaSet — Property in class QuotaSet

$QuotaSet — Property in class QuotaSet

BadResponseError — Class in namespace OpenStack\Common\Error

Represents a HTTP-specific error, caused by 4xx or 5xx response statuses.

BaseError — Class in namespace OpenStack\Common\Error

Base error class.

Builder — Class in namespace OpenStack\Common\Error

Class responsible for building meaningful exceptions. For HTTP problems, it produces a {see HttpError} exception, and supplies a error message with reasonable defaults. For user input problems, it produces a {see UserInputError} exception. For both, the problem is described, a potential solution is offered and a link to further information is included.

Builder — Class in namespace OpenStack\Common\Service

A Builder for easily creating OpenStack services.

$Credential — Property in class Credential

$Policy — Property in class Policy

$LoadBalancerStat — Property in class LoadBalancerStat

$LoadBalancerStat — Property in class LoadBalancerStat

Network::bulkCreate() — Method in class Network

Creates multiple networks in a single request.

Port::bulkCreate() — Method in class Port

Subnet::bulkCreate() — Method in class Subnet

Creates multiple subnets in a single request.

$Account — Property in class Account

$Container — Property in class Container

OpenStack::blockStorageV2() — Method in class OpenStack

Creates a new Block Storage v2 service.

C

$Snapshot — Property in class Snapshot

Snapshot::create() — Method in class Snapshot

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

$Volume — Property in class Volume

Volume::create() — Method in class Volume

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

VolumeType::create() — Method in class VolumeType

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

Service::createVolume() — Method in class Service

Provisions a new bootable volume, based either on an existing volume, image or snapshot.

Service::createVolumeType() — Method in class Service

Service::createSnapshot() — Method in class Service

Catalog — Class in namespace OpenStack\Common\Auth

Creatable — Class in namespace OpenStack\Common\Resource

Represents a resource that can be created.

Creatable::create() — Method in class Creatable

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

Builder::createService() — Method in class Builder

This method will return an OpenStack service ready fully built and ready for use. There is some initial setup that may prohibit users from directly instantiating the service class directly - this setup includes the configuration of the HTTP client's base URL, and the attachment of an authentication handler.

HandlerStack::create() — Method in class HandlerStack

$Fault — Property in class Fault

$Fault — Property in class Fault

Flavor::create() — Method in class Flavor

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

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

$HypervisorStatistic — Property in class HypervisorStatistic

$Image — Property in class Image

$Keypair — Property in class Keypair

Keypair::create() — Method in class Keypair

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

$QuotaSet — Property in class QuotaSet

The number of allowed instance cores for each tenant.

$Server — Property in class Server

Server::create() — Method in class Server

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

Server::changePassword() — Method in class Server

Changes the root password for a server.

Server::confirmResize() — Method in class Server

Confirms a previous resize operation.

Server::createImage() — Method in class Server

Creates an image for the current server.

Server::createInterfaceAttachment() — Method in class Server

Creates an interface attachment.

Service::createServer() — Method in class Service

Create a new server resource. This operation will provision a new virtual machine on a host chosen by your service API.

Service::createFlavor() — Method in class Service

Create a new flavor resource.

Service::createKeypair() — Method in class Service

Create or import keypair

Catalog — Class in namespace OpenStack\Identity\v2\Models

Represents an Identity v2 service catalog.

Catalog — Class in namespace OpenStack\Identity\v3\Models

Credential — Class in namespace OpenStack\Identity\v3\Models

Credential::create() — Method in class Credential

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

Domain::create() — Method in class Domain

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

Domain::checkUserRole() — Method in class Domain

Domain::checkGroupRole() — Method in class Domain

Endpoint::create() — Method in class Endpoint

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

Group::create() — Method in class Group

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

Group::checkMembership() — Method in class Group

Policy::create() — Method in class Policy

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

Project::create() — Method in class Project

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

Project::checkUserRole() — Method in class Project

Project::checkGroupRole() — Method in class Project

Role::create() — Method in class Role

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

Service::create() — Method in class Service

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

$Token — Property in class Token

Token::create() — Method in class Token

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

User::create() — Method in class User

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

Service::createService() — Method in class Service

Creates a new service according to the provided options.

Service::createEndpoint() — Method in class Service

Creates a new endpoint according to the provided options.

Service::createDomain() — Method in class Service

Creates a new domain according to the provided options.

Service::createProject() — Method in class Service

Creates a new project according to the provided options.

Service::createUser() — Method in class Service

Creates a new user according to the provided options.

Service::createGroup() — Method in class Service

Creates a new group according to the provided options.

Service::createCredential() — Method in class Service

Creates a new credential according to the provided options.

Service::createRole() — Method in class Service

Creates a new role according to the provided options.

Service::createPolicy() — Method in class Service

Creates a new policy according to the provided options.

$Image — Property in class Image

$Image — Property in class Image

$Image — Property in class Image

Image::create() — Method in class Image

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

$Member — Property in class Member

Member::create() — Method in class Member

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

Service::createImage() — Method in class Service

$Metric — Property in class Metric

$Metric — Property in class Metric

$Resource — Property in class Resource

$Resource — Property in class Resource

FloatingIp::create() — Method in class FloatingIp

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

Router::create() — Method in class Router

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

Service::createFloatingIp() — Method in class Service

Service::createRouter() — Method in class Service

SecurityGroup::create() — Method in class SecurityGroup

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

SecurityGroupRule::create() — Method in class SecurityGroupRule

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

Service::createSecurityGroup() — Method in class Service

Service::createSecurityGroupRule() — Method in class Service

LoadBalancer::create() — Method in class LoadBalancer

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

LoadBalancerHealthMonitor::create() — Method in class LoadBalancerHealthMonitor

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

$LoadBalancerListener — Property in class LoadBalancerListener

LoadBalancerListener::create() — Method in class LoadBalancerListener

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

LoadBalancerMember::create() — Method in class LoadBalancerMember

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

LoadBalancerPool::create() — Method in class LoadBalancerPool

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

Network::create() — Method in class Network

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

Port::create() — Method in class Port

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

$Subnet — Property in class Subnet

Subnet::create() — Method in class Subnet

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

Service::createNetwork() — Method in class Service

Create a new network resource.

Service::createNetworks() — Method in class Service

Create a new network resources.

Service::createSubnet() — Method in class Service

Create a new subnet resource.

Service::createSubnets() — Method in class Service

Create a new subnet resources.

Service::createPort() — Method in class Service

Create a new port resource.

Service::createPorts() — Method in class Service

Create new port resources.

Service::createLoadBalancer() — Method in class Service

Create a new loadbalancer resource.

Service::createLoadBalancerListener() — Method in class Service

Create a new loadbalancer Listener resource.

Service::createLoadBalancerPool() — Method in class Service

Create a new loadbalancer Pool resource.

Service::createLoadBalancerMember() — Method in class Service

Create a new loadbalancer member resource.

Service::createLoadBalancerHealthMonitor() — Method in class Service

Create a new loadbalancer healthmonitor resource.

$Account — Property in class Account

Container — Class in namespace OpenStack\ObjectStore\v1\Models

Container::create() — Method in class Container

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

Container::createObject() — Method in class Container

Creates a single object according to the values provided.

Container::createLargeObject() — Method in class Container

Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding container. When this completes, a manifest file is uploaded which references the prefix of the segments, allowing concatenation when a request is executed against the manifest.

$Object — Property in class Object

$Object — Property in class Object

$Object — Property in class Object

Object::create() — Method in class Object

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

Object::copy() — Method in class Object

Service::createContainer() — Method in class Service

Creates a new container according to the values provided.

Service::containerExists() — Method in class Service

Checks the existence of a container.

OpenStack::computeV2() — Method in class OpenStack

Creates a new Compute v2 service.

D

QuotaSet::delete() — Method in class QuotaSet

Permanently delete this resource.

$Snapshot — Property in class Snapshot

Snapshot::delete() — Method in class Snapshot

Permanently delete this resource.

$Volume — Property in class Volume

Volume::delete() — Method in class Volume

Permanently delete this resource.

$VolumeAttachment — Property in class VolumeAttachment

VolumeType::delete() — Method in class VolumeType

Permanently delete this resource.

AbstractApi::documented() — Method in class AbstractApi

JsonPatch::diff() — Method in class JsonPatch

Deletable — Class in namespace OpenStack\Common\Resource

Represents a resource that can be deleted.

Deletable::delete() — Method in class Deletable

Permanently delete this resource.

$Fault — Property in class Fault

$Flavor — Property in class Flavor

Flavor::delete() — Method in class Flavor

Permanently delete this resource.

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

Image::delete() — Method in class Image

Permanently delete this resource.

Image::deleteMetadataItem() — Method in class Image

Remove a specific metadata key.

$Keypair — Property in class Keypair

Keypair::delete() — Method in class Keypair

Permanently delete this resource.

QuotaSet::delete() — Method in class QuotaSet

Permanently delete this resource.

Server::delete() — Method in class Server

Permanently delete this resource.

Server::detachInterface() — Method in class Server

Detaches an interface attachment.

Server::deleteMetadataItem() — Method in class Server

Remove a specific metadata key.

Server::detachVolume() — Method in class Server

Detach a volume

Credential::delete() — Method in class Credential

Permanently delete this resource.

Domain — Class in namespace OpenStack\Identity\v3\Models

$Domain — Property in class Domain

Domain::delete() — Method in class Domain

Permanently delete this resource.

Endpoint::delete() — Method in class Endpoint

Permanently delete this resource.

$Group — Property in class Group

$Group — Property in class Group

Group::delete() — Method in class Group

Permanently delete this resource.

Policy::delete() — Method in class Policy

Permanently delete this resource.

$Project — Property in class Project

$Project — Property in class Project

Project::delete() — Method in class Project

Permanently delete this resource.

Role::delete() — Method in class Role

Permanently delete this resource.

$Service — Property in class Service

Service::delete() — Method in class Service

Permanently delete this resource.

$User — Property in class User

$User — Property in class User

$User — Property in class User

User::delete() — Method in class User

Permanently delete this resource.

JsonPatch::disableRestrictedPropRemovals() — Method in class JsonPatch

$Image — Property in class Image

Image::delete() — Method in class Image

Permanently delete this resource.

Image::deactivate() — Method in class Image

Image::downloadData() — Method in class Image

Member::delete() — Method in class Member

Permanently delete this resource.

$Resource — Property in class Resource

FloatingIp::delete() — Method in class FloatingIp

Permanently delete this resource.

Router::delete() — Method in class Router

Permanently delete this resource.

$SecurityGroup — Property in class SecurityGroup

SecurityGroup::delete() — Method in class SecurityGroup

Permanently delete this resource.

$SecurityGroupRule — Property in class SecurityGroupRule

SecurityGroupRule::delete() — Method in class SecurityGroupRule

Permanently delete this resource.

$LoadBalancer — Property in class LoadBalancer

LoadBalancer::delete() — Method in class LoadBalancer

Permanently delete this resource.

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

LoadBalancerHealthMonitor::delete() — Method in class LoadBalancerHealthMonitor

Permanently delete this resource.

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

LoadBalancerListener::delete() — Method in class LoadBalancerListener

Permanently delete this resource.

LoadBalancerMember::delete() — Method in class LoadBalancerMember

Permanently delete this resource.

$LoadBalancerPool — Property in class LoadBalancerPool

LoadBalancerPool::delete() — Method in class LoadBalancerPool

Permanently delete this resource.

LoadBalancerPool::deleteMember() — Method in class LoadBalancerPool

Delete a member

Network::delete() — Method in class Network

Permanently delete this resource.

$Port — Property in class Port

The UUID of the entity that uses this port. For example, a DHCP agent.

$Port — Property in class Port

The UUID of the device that uses this port. For example, a virtual server.

Port::delete() — Method in class Port

Permanently delete this resource.

Quota::delete() — Method in class Quota

Permanently delete this resource.

$Subnet — Property in class Subnet

Subnet::delete() — Method in class Subnet

Permanently delete this resource.

Container::delete() — Method in class Container

Permanently delete this resource.

Object::download() — Method in class Object

This call will perform a GET HTTP request for the given object and return back its content in the form of a Guzzle Stream object. Downloading an object will transfer all of the content for an object, and is therefore distinct from fetching its metadata (a HEAD request). The body of an object is not fetched by default to improve performance when handling large objects.

Object::delete() — Method in class Object

Permanently delete this resource.

E

OperatorInterface::execute() — Method in class OperatorInterface

A convenience method that assembles an operation and sends it to the remote API

OperatorInterface::executeAsync() — Method in class OperatorInterface

A convenience method that assembles an operation and asynchronously sends it to the remote API

OperatorTrait::execute() — Method in class OperatorTrait

{@inheritDoc}

OperatorTrait::executeAsync() — Method in class OperatorTrait

{@inheritDoc}

Listable::enumerate() — Method in class Listable

This method iterates over a collection of resources. It sends the operation's request to the API, parses the response, converts each element into {see self} and - if pagination is supported - continues to send requests until an empty collection is received back.

OperatorResource::executeWithState() — Method in class OperatorResource

OperatorResource::enumerate() — Method in class OperatorResource

{@inheritDoc}

OperatorResource::extractMultipleInstances() — Method in class OperatorResource

Enum — Class in namespace OpenStack\Compute\v2

Represents common constants.

$Catalog — Property in class Catalog

The catalog entries

Endpoint — Class in namespace OpenStack\Identity\v2\Models

Represents an Identity v2 catalog entry endpoint.

Entry — Class in namespace OpenStack\Identity\v2\Models

Represents an Identity v2 Catalog Entry.

$Entry — Property in class Entry

$Token — Property in class Token

Enum — Class in namespace OpenStack\Identity\v3

$Domain — Property in class Domain

Endpoint — Class in namespace OpenStack\Identity\v3\Models

$Project — Property in class Project

$Service — Property in class Service

$Token — Property in class Token

$Token — Property in class Token

$User — Property in class User

$User — Property in class User

$Resource — Property in class Resource

$GatewayInfo — Property in class GatewayInfo

$Router — Property in class Router

$SecurityGroupRule — Property in class SecurityGroupRule

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$Port — Property in class Port

A set of zero or more extra DHCP option pairs. An option pair consists of an option value and name.

$Subnet — Property in class Subnet

F

Utils::flattenJson() — Method in class Utils

Method for flattening a nested array.

Fault — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Fault.

Flavor — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Flavor.

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

$HypervisorStatistic — Property in class HypervisorStatistic

$Keypair — Property in class Keypair

$QuotaSet — Property in class QuotaSet

The number of allowed fixed IP addresses for each tenant.

$QuotaSet — Property in class QuotaSet

The number of allowed floating IP addresses for each tenant.

$Server — Property in class Server

$Server — Property in class Server

Service::factory() — Method in class Service

Service::factory() — Method in class Service

$Image — Property in class Image

$Resource — Property in class Resource

FixedIp — Class in namespace OpenStack\Networking\v2\Extensions\Layer3\Models

FloatingIp — Class in namespace OpenStack\Networking\v2\Extensions\Layer3\Models

$FloatingIp — Property in class FloatingIp

$FloatingIp — Property in class FloatingIp

$FloatingIp — Property in class FloatingIp

$GatewayInfo — Property in class GatewayInfo

$InterfaceAttachment — Property in class InterfaceAttachment

$Port — Property in class Port

The IP addresses for the port. Includes the IP address and UUID of the subnet.

$Quota — Property in class Quota

G

$QuotaSet — Property in class QuotaSet

$QuotaSet — Property in class QuotaSet

Snapshot::getMetadata() — Method in class Snapshot

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Volume::getMetadata() — Method in class Volume

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Service::getVolume() — Method in class Service

Service::getVolumeType() — Method in class Service

Service::getSnapshot() — Method in class Service

Service::getQuotaSet() — Method in class Service

Shows A Quota for a tenant

Operation::getPath() — Method in class Operation

Operation::getMethod() — Method in class Operation

Operation::getParam() — Method in class Operation

Operation::getJsonKey() — Method in class Operation

OperatorInterface::getOperation() — Method in class OperatorInterface

Retrieves a populated Operation according to the definition and values provided. A HTTP client is also injected into the object to allow it to communicate with the remote API.

OperatorTrait::getOperation() — Method in class OperatorTrait

{@inheritdoc}

Parameter::getName() — Method in class Parameter

Retrieve the name that will be used over the wire.

Parameter::getLocation() — Method in class Parameter

Parameter::getPath() — Method in class Parameter

Retrieves the parameter's path.

Parameter::getItemSchema() — Method in class Parameter

Retrieves the common schema that an array parameter applies to all its child elements.

Parameter::getProperty() — Method in class Parameter

Retrieves the child parameter for an object parameter.

Parameter::getPrefix() — Method in class Parameter

Retrieves the prefix for a parameter, if any.

Parameter::getPrefixedName() — Method in class Parameter

Catalog::getServiceUrl() — Method in class Catalog

Attempts to retrieve the base URL for a service from the catalog according to the arguments provided.

Token::getId() — Method in class Token

BadResponseError::getRequest() — Method in class BadResponseError

BadResponseError::getResponse() — Method in class BadResponseError

JsonPath::getStructure() — Method in class JsonPath

Return the updated structure.

JsonPath::get() — Method in class JsonPath

Get a path's value. If no path can be matched, NULL is returned.

Schema::getPropertyPaths() — Method in class Schema

Schema::getErrors() — Method in class Schema

Schema::getErrorString() — Method in class Schema

Alias::getValue() — Method in class Alias

HasMetadata::getMetadata() — Method in class HasMetadata

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Image::getMetadata() — Method in class Image

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Image::getMetadataItem() — Method in class Image

Retrieve the value for a specific metadata key.

Server::getVncConsole() — Method in class Server

Gets a VNC console for a server.

Server::getRDPConsole() — Method in class Server

Gets a RDP console for a server.

Server::getSpiceConsole() — Method in class Server

Gets a Spice console for a server.

Server::getSerialConsole() — Method in class Server

Gets a serial console for a server.

Server::getInterfaceAttachment() — Method in class Server

Gets an interface attachment.

Server::getMetadata() — Method in class Server

Retrieves metadata from the API.

Server::getMetadataItem() — Method in class Server

Retrieve the value for a specific metadata key.

Service::getServer() — Method in class Service

Retrieve a server 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 Server::retrieve}. For example:

Service::getFlavor() — Method in class Service

Retrieve a flavor 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 Flavor::retrieve}.

Service::getImage() — Method in class Service

Retrieve an image 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 Image::retrieve}.

Service::getKeypair() — Method in class Service

Get keypair

Service::getLimits() — Method in class Service

Shows rate and absolute limits for the tenant

Service::getHypervisorStatistics() — Method in class Service

Shows summary statistics for all hypervisors over all compute nodes.

Service::getHypervisor() — Method in class Service

Shows details for a given hypervisor.

Service::getHost() — Method in class Service

Retrieve a host 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 Host::retrieve}. For example:

Service::getQuotaSet() — Method in class Service

Shows A Quota for a tenant

Catalog::getServiceUrl() — Method in class Catalog

Attempts to retrieve the base URL for a service from the catalog according to the arguments provided.

Endpoint::getUrl() — Method in class Endpoint

Retrieves a URL for the endpoint based on a specific type.

Entry::getEndpointUrl() — Method in class Entry

Retrieves the catalog entry's URL according to a specific region and URL type

Token::getId() — Method in class Token

Service::generateToken() — Method in class Service

Generates a new authentication token

$Assignment — Property in class Assignment

Catalog::getServiceUrl() — Method in class Catalog

Attempts to retrieve the base URL for a service from the catalog according to the arguments provided.

Domain::grantUserRole() — Method in class Domain

Domain::grantGroupRole() — Method in class Domain

Group — Class in namespace OpenStack\Identity\v3\Models

Project::grantUserRole() — Method in class Project

Project::grantGroupRole() — Method in class Project

Service::getUrl() — Method in class Service

Retrieve the base URL for a service.

Token::getId() — Method in class Token

Service::generateToken() — Method in class Service

Generates a new authentication token

Service::getToken() — Method in class Service

Retrieves a token object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getService() — Method in class Service

Retrieves a service object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getEndpoint() — Method in class Service

Retrieves an endpoint object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getDomain() — Method in class Service

Retrieves a domain object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getProject() — Method in class Service

Retrieves a project object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getUser() — Method in class Service

Retrieves a user object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getGroup() — Method in class Service

Retrieves a group object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getCredential() — Method in class Service

Retrieves a credential object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getPolicy() — Method in class Service

Retrieves a policy object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Image::getMember() — Method in class Image

Service::getImage() — Method in class Service

Resource::getMetric() — Method in class Resource

Resource::getMetricMeasures() — Method in class Resource

Service::getResource() — Method in class Service

Retrieves a Resource object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

Service::getMetric() — Method in class Service

Retrieves a Metric object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.

GatewayInfo — Class in namespace OpenStack\Networking\v2\Extensions\Layer3\Models

Service::getFloatingIp() — Method in class Service

Service::getRouter() — Method in class Service

Service::getSecurityGroup() — Method in class Service

Service::getSecurityGroupRule() — Method in class Service

LoadBalancer::getStats() — Method in class LoadBalancer

Get stats for this loadbalancer

LoadBalancer::getStatuses() — Method in class LoadBalancer

Get the status tree for this loadbalancer

LoadBalancerPool::getMember() — Method in class LoadBalancerPool

Get an instance of a member

$Subnet — Property in class Subnet

Service::getNetwork() — Method in class Service

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}.

Service::getSubnet() — Method in class Service

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}.

Service::getPort() — Method in class Service

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}.

Service::getQuota() — Method in class Service

Lists quotas for a project.

Service::getDefaultQuota() — Method in class Service

Lists default quotas for a project

Service::getLoadBalancer() — Method in class Service

Retrieve an instance of a LoadBalancer object

Service::getLoadBalancerListener() — Method in class Service

Retrieve an instance of a loadbalancer listener object

Service::getLoadBalancerPool() — Method in class Service

Retrieve an instance of a loadbalancer Pool object

Service::getLoadBalancerMember() — Method in class Service

Retrieve an instance of a loadbalancer Member object

Service::getLoadBalancerHealthMonitor() — Method in class Service

Retrieve an instance of a loadbalancer healthmonitor object

Account::getMetadata() — Method in class Account

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Container::getMetadata() — Method in class Container

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Container::getObject() — Method in class Container

Retrieves an Object and populates its name and containerName properties according to the name provided and the name of this container. A HTTP call will not be executed by default - you need to call {see Object::retrieve} or {see Object::download} on the returned Object object to do that.

Object::getPublicUri() — Method in class Object

Retrieves the public URI for this resource.

Object::getMetadata() — Method in class Object

Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.

Service::getAccount() — Method in class Service

Retrieves an Account object.

Service::getContainer() — Method in class Service

Retrieves a Container object and populates its name according to the value provided. Please note that the remote API is not contacted.

H

$Volume — Property in class Volume

Operation::hasParam() — Method in class Operation

Indicates whether this operation supports a parameter.

Parameter::hasLocation() — Method in class Parameter

Verifies whether the given location matches the parameter's location.

Token::hasExpired() — Method in class Token

Indicates whether the token has expired or not.

Builder::httpError() — Method in class Builder

Helper method responsible for constructing and returning {see BadResponseError} exceptions.

HydratorStrategyTrait — Class in namespace OpenStack\Common

Represents common functionality for populating, or "hydrating", an object with arbitrary data.

HydratorStrategyTrait::hydrate() — Method in class HydratorStrategyTrait

Hydrates an object with set data

HasMetadata — Class in namespace OpenStack\Common\Resource

HasWaiterTrait — Class in namespace OpenStack\Common\Resource

Contains reusable functionality for resources that have long operations which require waiting in order to reach a particular state.

HandlerStack — Class in namespace OpenStack\Common\Transport

Middleware::httpErrors() — Method in class Middleware

Middleware::history() — Method in class Middleware

$AvailabilityZone — Property in class AvailabilityZone

Host — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Host.

Hypervisor — Class in namespace OpenStack\Compute\v2\Models

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

HypervisorStatistic — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Quota

$Server — Property in class Server

$Server — Property in class Server

Token::hasExpired() — Method in class Token

Indicates whether the token has expired or not.

Token::hasExpired() — Method in class Token

Indicates whether the token has expired or not.

$Resource — Property in class Resource

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerPool — Property in class LoadBalancerPool

$Subnet — Property in class Subnet

$Object — Property in class Object

I

$Snapshot — Property in class Snapshot

$Volume — Property in class Volume

$VolumeAttachment — Property in class VolumeAttachment

$VolumeType — Property in class VolumeType

AbstractParams::isSupportedLocation() — Method in class AbstractParams

AbstractParams::id() — Method in class AbstractParams

AbstractParams::idPath() — Method in class AbstractParams

Parameter::isRequired() — Method in class Parameter

Indicates whether the user must provide a value for this parameter.

Parameter::isArray() — Method in class Parameter

Indicates whether this parameter represents an array type

Parameter::isObject() — Method in class Parameter

Indicates whether this parameter represents an object type

IdentityService — Class in namespace OpenStack\Common\Auth

Schema::isValid() — Method in class Schema

Iterator — Class in namespace OpenStack\Common\Resource

$Flavor — Property in class Flavor

$Hypervisor — Property in class Hypervisor

Image — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Image

$Image — Property in class Image

$Keypair — Property in class Keypair

$QuotaSet — Property in class QuotaSet

The number of allowed bytes of content for each injected file.

$QuotaSet — Property in class QuotaSet

The number of allowed bytes for each injected file path.

$QuotaSet — Property in class QuotaSet

The number of allowed injected files for each tenant.

$QuotaSet — Property in class QuotaSet

The number of allowed instances for each tenant.

$Server — Property in class Server

$Server — Property in class Server

$Server — Property in class Server

$Server — Property in class Server

$Endpoint — Property in class Endpoint

$Token — Property in class Token

$Token — Property in class Token

$Credential — Property in class Credential

$Domain — Property in class Domain

$Endpoint — Property in class Endpoint

$Endpoint — Property in class Endpoint

Endpoint::interfaceMatches() — Method in class Endpoint

$Group — Property in class Group

$Policy — Property in class Policy

$Project — Property in class Project

$Role — Property in class Role

$Service — Property in class Service

$Token — Property in class Token

$Token — Property in class Token

$User — Property in class User

Image — Class in namespace OpenStack\Images\v2\Models

$Image — Property in class Image

$Member — Property in class Member

$Member — Property in class Member

$Metric — Property in class Metric

$Resource — Property in class Resource

$Resource — Property in class Resource

$FixedIp — Property in class FixedIp

$FloatingIp — Property in class FloatingIp

$Router — Property in class Router

$SecurityGroup — Property in class SecurityGroup

$SecurityGroupRule — Property in class SecurityGroupRule

InterfaceAttachment — Class in namespace OpenStack\Networking\v2\Models

$InterfaceAttachment — Property in class InterfaceAttachment

$LoadBalancer — Property in class LoadBalancer

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerStatus — Property in class LoadBalancerStatus

$Network — Property in class Network

$Port — Property in class Port

The UUID of the port.

$Subnet — Property in class Subnet

$Subnet — Property in class Subnet

OpenStack::identityV2() — Method in class OpenStack

Creates a new Identity v2 service.

OpenStack::identityV3() — Method in class OpenStack

Creates a new Identity v3 service.

OpenStack::imagesV2() — Method in class OpenStack

Creates a new Images v2 service.

J

JsonPath — Class in namespace OpenStack\Common

This class allows arbitrary data structures to be inserted into, and extracted from, deep arrays and JSON-serialized strings. Say, for example, that you have this array as an input:

JsonPatch — Class in namespace OpenStack\Common\JsonSchema

JsonSerializer — Class in namespace OpenStack\Common\Transport

Class responsible for populating the JSON body of a {see GuzzleHttp\Message\Request} object.

Utils::jsonDecode() — Method in class Utils

JsonPatch — Class in namespace OpenStack\Images\v2

K

Keypair — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Keypair

$QuotaSet — Property in class QuotaSet

The number of allowed key pairs for each user.

L

Service::listVolumes() — Method in class Service

Lists all available volumes.

Service::listVolumeTypes() — Method in class Service

Service::listSnapshots() — Method in class Service

AbstractParams::limit() — Method in class AbstractParams

Listable — Class in namespace OpenStack\Common\Resource

Represents a resource that can be enumerated (listed over).

Middleware::log() — Method in class Middleware

$Flavor — Property in class Flavor

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

$HypervisorStatistic — Property in class HypervisorStatistic

$Image — Property in class Image

Limit — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Limit

$Server — Property in class Server

Server::listAddresses() — Method in class Server

Iterates over all the IP addresses for this server.

Server::listInterfaceAttachments() — Method in class Server

Returns Generator for InterfaceAttachment

Server::listSecurityGroups() — Method in class Server

Returns Generator for SecurityGroups

Server::listVolumeAttachments() — Method in class Server

Returns Generator for VolumeAttachment

Service::listServers() — Method in class Service

List servers.

Service::listFlavors() — Method in class Service

List flavors.

Service::listImages() — Method in class Service

List images.

Service::listKeypairs() — Method in class Service

List key pairs.

Service::listHypervisors() — Method in class Service

List hypervisors.

Service::listHosts() — Method in class Service

List hosts.

Service::listAvailabilityZones() — Method in class Service

List AZs

$Credential — Property in class Credential

$Domain — Property in class Domain

Domain::listUserRoles() — Method in class Domain

Domain::listGroupRoles() — Method in class Domain

$Endpoint — Property in class Endpoint

$Group — Property in class Group

Group::listUsers() — Method in class Group

$Policy — Property in class Policy

$Project — Property in class Project

Project::listUserRoles() — Method in class Project

Project::listGroupRoles() — Method in class Project

$Role — Property in class Role

$Service — Property in class Service

$User — Property in class User

User::listGroups() — Method in class User

User::listProjects() — Method in class User

Service::listServices() — Method in class Service

Returns a generator which will yield a collection of service objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listEndpoints() — Method in class Service

Returns a generator which will yield a collection of endpoint objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listDomains() — Method in class Service

Returns a generator which will yield a collection of domain objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listProjects() — Method in class Service

Returns a generator which will yield a collection of project objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listUsers() — Method in class Service

Returns a generator which will yield a collection of user objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listGroups() — Method in class Service

Returns a generator which will yield a collection of group objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listCredentials() — Method in class Service

Returns a generator which will yield a collection of credential objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listRoles() — Method in class Service

Returns a generator which will yield a collection of role objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listRoleAssignments() — Method in class Service

Returns a generator which will yield a collection of role assignment objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Service::listPolicies() — Method in class Service

Returns a generator which will yield a collection of policy objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.

Image::listMembers() — Method in class Image

Service::listImages() — Method in class Service

Resource::listResourceMetrics() — Method in class Resource

Service::listResourceTypes() — Method in class Service

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\ResourceType type in a generator format.

Service::listResources() — Method in class Service

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

Service::listMetrics() — Method in class Service

Retrieves a collection of Metric type in a generator format.

Service::listFloatingIps() — Method in class Service

Service::listRouters() — Method in class Service

Service::listSecurityGroups() — Method in class Service

Service::listSecurityGroupRules() — Method in class Service

LoadBalancer — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 LoadBalancer

$LoadBalancer — Property in class LoadBalancer

LoadBalancerHealthMonitor — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 LoadBalancer Health Monitor

LoadBalancerListener — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 LoadBalancer Listener

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

LoadBalancerMember — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 LoadBalancer member

LoadBalancerPool — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 LoadBalancer pool

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerPool — Property in class LoadBalancerPool

LoadBalancerStat — Class in namespace OpenStack\Networking\v2\Models

Represents Neutron v2 LoadBalancer Stats

$LoadBalancerStat — Property in class LoadBalancerStat

LoadBalancerStatus — Class in namespace OpenStack\Networking\v2\Models

Represents Neutron v2 LoadBalancer Stats

$LoadBalancerStatus — Property in class LoadBalancerStatus

$LoadBalancerStatus — Property in class LoadBalancerStatus

$Subnet — Property in class Subnet

Service::listNetworks() — Method in class Service

List networks.

Service::listSubnets() — Method in class Service

List subnets.

Service::listPorts() — Method in class Service

List ports.

Service::listQuotas() — Method in class Service

Lists quotas for projects with non-default quota values.

Service::listLoadBalancers() — Method in class Service

Lists loadbalancers for projects

Service::listLoadBalancerListeners() — Method in class Service

Lists loadbalancer listeners

Service::listLoadBalancerPools() — Method in class Service

Lists loadbalancer pools

Service::listLoadBalancerMembers() — Method in class Service

Lists loadbalancer members

Service::listLoadBalancerHealthMonitors() — Method in class Service

Lists loadbalancer healthmonitors

Container::listObjects() — Method in class Container

Retrieves a collection of object resources in the form of a generator.

$Object — Property in class Object

Service::listContainers() — Method in class Service

Retrieves a collection of container resources in a generator format.

M

$Snapshot — Property in class Snapshot

Snapshot::mergeMetadata() — Method in class Snapshot

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

$Volume — Property in class Volume

Volume::mergeMetadata() — Method in class Volume

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

AbstractParams::marker() — Method in class AbstractParams

OperatorInterface::model() — Method in class OperatorInterface

OperatorTrait::model() — Method in class OperatorTrait

{@inheritDoc}

JsonPatch::makeDiff() — Method in class JsonPatch

AbstractResource::model() — Method in class AbstractResource

HasMetadata::mergeMetadata() — Method in class HasMetadata

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

OperatorResource::model() — Method in class OperatorResource

ResourceInterface::model() — Method in class ResourceInterface

Middleware — Class in namespace OpenStack\Common\Transport

Middleware::mapRequest() — Method in class Middleware

Middleware::mapResponse() — Method in class Middleware

$Fault — Property in class Fault

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

$HypervisorStatistic — Property in class HypervisorStatistic

$Image — Property in class Image

$Image — Property in class Image

$Image — Property in class Image

Image::mergeMetadata() — Method in class Image

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

$QuotaSet — Property in class QuotaSet

The number of allowed metadata items for each instance.

$Server — Property in class Server

Server::mergeMetadata() — Method in class Server

Merges the existing metadata for the server with the values provided. Any existing keys referenced in the user options will be replaced with the user's new values. All other existing keys will remain unaffected.

Entry::matches() — Method in class Entry

Indicates whether this catalog entry matches a certain name and type.

$Token — Property in class Token

$Image — Property in class Image

$Image — Property in class Image

Member — Class in namespace OpenStack\Images\v2\Models

Metric — Class in namespace OpenStack\Metric\v1\Gnocchi\Models

$Resource — Property in class Resource

$InterfaceAttachment — Property in class InterfaceAttachment

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerPool — Property in class LoadBalancerPool

$Port — Property in class Port

The MAC address of the port.

$Account — Property in class Account

Account::mergeMetadata() — Method in class Account

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

$Container — Property in class Container

Container::mergeMetadata() — Method in class Container

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

MetadataTrait — Class in namespace OpenStack\ObjectStore\v1\Models

$Object — Property in class Object

Object::mergeMetadata() — Method in class Object

Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:

OpenStack::metricGnocchiV1() — Method in class OpenStack

Creates a new Gnocchi Metric service v1

N

$Snapshot — Property in class Snapshot

$Volume — Property in class Volume

$VolumeType — Property in class VolumeType

AbstractParams::name() — Method in class AbstractParams

NotImplementedError — Class in namespace OpenStack\Common\Error

Error to indicate functionality which has not been implemented yet.

Schema::normalizeObject() — Method in class Schema

OperatorResource::newInstance() — Method in class OperatorResource

Will create a new instance of this class with the current HTTP client and API injected in. This is useful when enumerating over a collection since multiple copies of the same resource class are needed.

Utils::normalizeUrl() — Method in class Utils

Method for normalize an URL string.

$AvailabilityZone — Property in class AvailabilityZone

$Flavor — Property in class Flavor

$Host — Property in class Host

$Image — Property in class Image

$Keypair — Property in class Keypair

$Server — Property in class Server

$Entry — Property in class Entry

$Domain — Property in class Domain

$Endpoint — Property in class Endpoint

$Group — Property in class Group

$Project — Property in class Project

$Role — Property in class Role

$Service — Property in class Service

$User — Property in class User

$Image — Property in class Image

$Metric — Property in class Metric

$ResourceType — Property in class ResourceType

$GatewayInfo — Property in class GatewayInfo

$Router — Property in class Router

$SecurityGroup — Property in class SecurityGroup

$InterfaceAttachment — Property in class InterfaceAttachment

$LoadBalancer — Property in class LoadBalancer

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerStatus — Property in class LoadBalancerStatus

Network — Class in namespace OpenStack\Networking\v2\Models

Represents a Networking v2 Network.

$Network — Property in class Network

$Port — Property in class Port

The port name.

$Port — Property in class Port

The UUID of the attached network.

$Quota — Property in class Quota

$Subnet — Property in class Subnet

$Subnet — Property in class Subnet

$Container — Property in class Container

$Object — Property in class Object

OpenStack::networkingV2() — Method in class OpenStack

Creates a new Networking v2 service.

OpenStack::networkingV2ExtLayer3() — Method in class OpenStack

Creates a new Networking v2 Layer 3 service.

OpenStack::networkingV2ExtSecGroups() — Method in class OpenStack

Creates a new Networking v2 Layer 3 service.

O

Operation — Class in namespace OpenStack\Common\Api

This class represents an OpenStack API operation. It encapsulates most aspects of the REST operation: its HTTP method, the URL path, its top-level JSON key, and all of its {see Parameter} objects.

OperatorInterface — Class in namespace OpenStack\Common\Api

An operator is any resource or service that can invoke and send REST operations. In other words, it is any class that can send requests and receive responses with a HTTP client. To do this it needs two things: a {see ClientInterface} for handling HTTP transactions and an {see ApiInterface} for handling how operations are created.

OperatorTrait — Class in namespace OpenStack\Common\Api

ArrayAccessTrait::offsetSet() — Method in class ArrayAccessTrait

Sets an internal key with a value.

ArrayAccessTrait::offsetExists() — Method in class ArrayAccessTrait

Checks whether an internal key exists.

ArrayAccessTrait::offsetUnset() — Method in class ArrayAccessTrait

Unsets an internal key.

ArrayAccessTrait::offsetGet() — Method in class ArrayAccessTrait

Retrieves an internal key.

OperatorResource — Class in namespace OpenStack\Common\Resource

$Image — Property in class Image

$Resource — Property in class Resource

$LoadBalancer — Property in class LoadBalancer

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerStatus — Property in class LoadBalancerStatus

$Account — Property in class Account

$Container — Property in class Container

Container::objectExists() — Method in class Container

Identifies whether an object exists in this container.

Object — Class in namespace OpenStack\ObjectStore\v1\Models

OpenStack — Class in namespace OpenStack

This class is the primary entry point for working with the SDK. It allows for the easy creation of OpenStack services.

OpenStack::objectStoreV1() — Method in class OpenStack

Creates a new Object Store v1 service.

P

$QuotaSet — Property in class QuotaSet

Snapshot::populateFromResponse() — Method in class Snapshot

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Snapshot::parseMetadata() — Method in class Snapshot

Extracts metadata from a response object and returns it in the form of an associative array.

Volume::populateFromResponse() — Method in class Volume

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Volume::parseMetadata() — Method in class Volume

Extracts metadata from a response object and returns it in the form of an associative array.

Parameter — Class in namespace OpenStack\Common\Api

Represents an individual request parameter in a RESTful operation. A parameter can take on many forms: in a URL path, in a URL query, in a JSON body, and in a HTTP header. It is worth documenting brifly each variety of parameter:

AbstractResource::populateFromResponse() — Method in class AbstractResource

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

AbstractResource::populateFromArray() — Method in class AbstractResource

$Alias — Property in class Alias

HasMetadata::parseMetadata() — Method in class HasMetadata

Extracts metadata from a response object and returns it in the form of an associative array.

ResourceInterface::populateFromResponse() — Method in class ResourceInterface

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

ResourceInterface::populateFromArray() — Method in class ResourceInterface

Middleware::prepareBody() — Method in class Middleware

$Image — Property in class Image

Image::parseMetadata() — Method in class Image

Extracts metadata from a response object and returns it in the form of an associative array.

$Keypair — Property in class Keypair

$Keypair — Property in class Keypair

Keypair::populateFromArray() — Method in class Keypair

$Server — Property in class Server

$Server — Property in class Server

Server::parseMetadata() — Method in class Server

Catalog::populateFromResponse() — Method in class Catalog

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

$Endpoint — Property in class Endpoint

Token::populateFromResponse() — Method in class Token

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Catalog::populateFromArray() — Method in class Catalog

$Credential — Property in class Credential

Policy — Class in namespace OpenStack\Identity\v3\Models

$Policy — Property in class Policy

Project — Class in namespace OpenStack\Identity\v3\Models

$Project — Property in class Project

$Token — Property in class Token

Token::populateFromResponse() — Method in class Token

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

$Image — Property in class Image

Image::populateFromArray() — Method in class Image

$Resource — Property in class Resource

$FloatingIp — Property in class FloatingIp

$SecurityGroupRule — Property in class SecurityGroupRule

$SecurityGroupRule — Property in class SecurityGroupRule

$SecurityGroupRule — Property in class SecurityGroupRule

$InterfaceAttachment — Property in class InterfaceAttachment

$InterfaceAttachment — Property in class InterfaceAttachment

$LoadBalancer — Property in class LoadBalancer

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerStatus — Property in class LoadBalancerStatus

Port — Class in namespace OpenStack\Networking\v2\Models

$Port — Property in class Port

The port security status. The status is enabled (true) or disabled (false).

$Quota — Property in class Quota

Account::populateFromResponse() — Method in class Account

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Container::populateFromResponse() — Method in class Container

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

MetadataTrait::parseMetadata() — Method in class MetadataTrait

Object::populateFromResponse() — Method in class Object

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Q

QuotaSet — Class in namespace OpenStack\BlockStorage\v2\Models

Represents a BlockStorage v2 Quota Set

QuotaSet — Class in namespace OpenStack\Compute\v2\Models

Represents a Compute v2 Quota Set

Quota — Class in namespace OpenStack\Networking\v2\Models

Represents a Neutron v2 Quota

R

QuotaSet::retrieve() — Method in class QuotaSet

Retrieve details of the current resource from the remote API.

Snapshot::retrieve() — Method in class Snapshot

Retrieve details of the current resource from the remote API.

Snapshot::resetMetadata() — Method in class Snapshot

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

Volume::retrieve() — Method in class Volume

Retrieve details of the current resource from the remote API.

Volume::resetMetadata() — Method in class Volume

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

HasMetadata::resetMetadata() — Method in class HasMetadata

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

ResourceInterface — Class in namespace OpenStack\Common\Resource

Represents an API resource.

Retrievable — Class in namespace OpenStack\Common\Resource

A resource that supports a GET or HEAD operation to retrieve more details.

Retrievable::retrieve() — Method in class Retrievable

Retrieve details of the current resource from the remote API.

Middleware::retry() — Method in class Middleware

RequestSerializer — Class in namespace OpenStack\Common\Transport

$Flavor — Property in class Flavor

Flavor::retrieve() — Method in class Flavor

Retrieve details of the current resource from the remote API.

Host::retrieve() — Method in class Host

Retrieve details of the current resource from the remote API.

$Hypervisor — Property in class Hypervisor

Hypervisor::retrieve() — Method in class Hypervisor

Retrieve details of the current resource from the remote API.

$HypervisorStatistic — Property in class HypervisorStatistic

Image::retrieve() — Method in class Image

Retrieve details of the current resource from the remote API.

Image::resetMetadata() — Method in class Image

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

Keypair::retrieve() — Method in class Keypair

Retrieve details of the current resource from the remote API.

$Limit — Property in class Limit

$QuotaSet — Property in class QuotaSet

The amount of allowed instance RAM, in MB, for each tenant.

QuotaSet::retrieve() — Method in class QuotaSet

Retrieve details of the current resource from the remote API.

Server::retrieve() — Method in class Server

Retrieve details of the current resource from the remote API.

Server::reboot() — Method in class Server

Reboots the server.

Server::rebuild() — Method in class Server

Rebuilds the server.

Server::rescue() — Method in class Server

Rescues the server.

Server::resize() — Method in class Server

Resizes the server to a new flavor. Once this operation is complete and server has transitioned to an active state, you will either need to call {see confirmResize()} or {see revertResize()}.

Server::revertResize() — Method in class Server

Reverts a previous resize operation.

Server::resetMetadata() — Method in class Server

Resets all the metadata for this server with the values provided. All existing metadata keys will either be replaced or removed.

Server::removeSecurityGroup() — Method in class Server

Add security group to a server (addSecurityGroup action)

$Endpoint — Property in class Endpoint

$Assignment — Property in class Assignment

Credential::retrieve() — Method in class Credential

Retrieve details of the current resource from the remote API.

Domain::retrieve() — Method in class Domain

Retrieve details of the current resource from the remote API.

Domain::revokeUserRole() — Method in class Domain

Domain::revokeGroupRole() — Method in class Domain

$Endpoint — Property in class Endpoint

Endpoint::retrieve() — Method in class Endpoint

Retrieve details of the current resource from the remote API.

Endpoint::regionMatches() — Method in class Endpoint

Group::retrieve() — Method in class Group

Retrieve details of the current resource from the remote API.

Group::removeUser() — Method in class Group

Policy::retrieve() — Method in class Policy

Retrieve details of the current resource from the remote API.

Project::retrieve() — Method in class Project

Retrieve details of the current resource from the remote API.

Project::revokeUserRole() — Method in class Project

Project::revokeGroupRole() — Method in class Project

Role — Class in namespace OpenStack\Identity\v3\Models

Service::retrieve() — Method in class Service

Retrieve details of the current resource from the remote API.

$Token — Property in class Token

Token::retrieve() — Method in class Token

Retrieve details of the current resource from the remote API.

User::retrieve() — Method in class User

Retrieve details of the current resource from the remote API.

Service::revokeToken() — Method in class Service

Revokes a token, identified by its ID. After this operation completes, users will not be able to use this token again for authentication.

Image::retrieve() — Method in class Image

Retrieve details of the current resource from the remote API.

Image::reactivate() — Method in class Image

Member::retrieve() — Method in class Member

Retrieve details of the current resource from the remote API.

$Metric — Property in class Metric

Metric::retrieve() — Method in class Metric

Retrieve details of the current resource from the remote API.

Resource — Class in namespace OpenStack\Metric\v1\Gnocchi\Models

$Resource — Property in class Resource

$Resource — Property in class Resource

Resource::retrieve() — Method in class Resource

Retrieve details of the current resource from the remote API.

ResourceType — Class in namespace OpenStack\Metric\v1\Gnocchi\Models

$FloatingIp — Property in class FloatingIp

FloatingIp::retrieve() — Method in class FloatingIp

Retrieve details of the current resource from the remote API.

Router — Class in namespace OpenStack\Networking\v2\Extensions\Layer3\Models

$Router — Property in class Router

Router::retrieve() — Method in class Router

Retrieve details of the current resource from the remote API.

Router::removeInterface() — Method in class Router

SecurityGroup::retrieve() — Method in class SecurityGroup

Retrieve details of the current resource from the remote API.

$SecurityGroupRule — Property in class SecurityGroupRule

$SecurityGroupRule — Property in class SecurityGroupRule

SecurityGroupRule::retrieve() — Method in class SecurityGroupRule

Retrieve details of the current resource from the remote API.

LoadBalancer::retrieve() — Method in class LoadBalancer

Retrieve details of the current resource from the remote API.

LoadBalancerHealthMonitor::retrieve() — Method in class LoadBalancerHealthMonitor

Retrieve details of the current resource from the remote API.

LoadBalancerListener::retrieve() — Method in class LoadBalancerListener

Retrieve details of the current resource from the remote API.

LoadBalancerMember::retrieve() — Method in class LoadBalancerMember

Retrieve details of the current resource from the remote API.

LoadBalancerPool::retrieve() — Method in class LoadBalancerPool

Retrieve details of the current resource from the remote API.

LoadBalancerStat::retrieve() — Method in class LoadBalancerStat

Retrieve details of the current resource from the remote API.

LoadBalancerStatus::retrieve() — Method in class LoadBalancerStatus

Retrieve details of the current resource from the remote API.

Network::retrieve() — Method in class Network

Retrieve details of the current resource from the remote API.

Port::retrieve() — Method in class Port

Retrieve details of the current resource from the remote API.

$Quota — Property in class Quota

$Quota — Property in class Quota

Quota::retrieve() — Method in class Quota

Retrieve details of the current resource from the remote API.

Subnet::retrieve() — Method in class Subnet

Retrieve details of the current resource from the remote API.

Account::retrieve() — Method in class Account

Retrieve details of the current resource from the remote API.

Account::resetMetadata() — Method in class Account

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

Container::retrieve() — Method in class Container

Retrieve details of the current resource from the remote API.

Container::resetMetadata() — Method in class Container

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

Object::retrieve() — Method in class Object

{@inheritdoc}

Object::resetMetadata() — Method in class Object

Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:

S

$QuotaSet — Property in class QuotaSet

$QuotaSet — Property in class QuotaSet

Snapshot — Class in namespace OpenStack\BlockStorage\v2\Models

$Snapshot — Property in class Snapshot

$Snapshot — Property in class Snapshot

$Volume — Property in class Volume

$Volume — Property in class Volume

$Volume — Property in class Volume

$Volume — Property in class Volume

$VolumeAttachment — Property in class VolumeAttachment

Service — Class in namespace OpenStack\BlockStorage\v2

AbstractParams::sortDir() — Method in class AbstractParams

AbstractParams::sortKey() — Method in class AbstractParams

Parameter::setName() — Method in class Parameter

Sets the name of the parameter to a new value

BadResponseError::setRequest() — Method in class BadResponseError

BadResponseError::setResponse() — Method in class BadResponseError

Builder::str() — Method in class Builder

HydratorStrategyTrait::set() — Method in class HydratorStrategyTrait

JsonPath::set() — Method in class JsonPath

Set a node in the structure

Schema — Class in namespace OpenStack\Common\JsonSchema

AbstractResource::serialize() — Method in class AbstractResource

ServiceInterface — Class in namespace OpenStack\Common\Service

Service interface.

JsonSerializer::stockJson() — Method in class JsonSerializer

A generic method that will populate a JSON structure with a value according to a schema. It supports multiple types and will delegate accordingly.

RequestSerializer::serializeOptions() — Method in class RequestSerializer

Serializable — Class in namespace OpenStack\Common\Transport

Serializable::serialize() — Method in class Serializable

$AvailabilityZone — Property in class AvailabilityZone

$Flavor — Property in class Flavor

$Host — Property in class Host

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$Image — Property in class Image

$QuotaSet — Property in class QuotaSet

The number of allowed rules for each security group.

$QuotaSet — Property in class QuotaSet

The number of allowed security groups for each tenant.

$QuotaSet — Property in class QuotaSet

The number of allowed server groups for each tenant.

$QuotaSet — Property in class QuotaSet

The number of allowed members for each server group.

Server — Class in namespace OpenStack\Compute\v2\Models

$Server — Property in class Server

Server::start() — Method in class Server

Starts server

Server::stop() — Method in class Server

Stops server

Service — Class in namespace OpenStack\Compute\v2

Compute v2 service for OpenStack.

Endpoint::supportsRegion() — Method in class Endpoint

Indicates whether a given region is supported

Endpoint::supportsUrlType() — Method in class Endpoint

Indicates whether a given URL type is supported

Service — Class in namespace OpenStack\Identity\v2

Represents the OpenStack Identity v2 service.

$Assignment — Property in class Assignment

$Catalog — Property in class Catalog

$Endpoint — Property in class Endpoint

Service — Class in namespace OpenStack\Identity\v3\Models

Service — Class in namespace OpenStack\Identity\v3

Represents the Keystone v3 service.

$Image — Property in class Image

$Image — Property in class Image

$Image — Property in class Image

$Member — Property in class Member

$Member — Property in class Member

Schema — Class in namespace OpenStack\Images\v2\Models

Service — Class in namespace OpenStack\Images\v2

$Resource — Property in class Resource

$Resource — Property in class Resource

$ResourceType — Property in class ResourceType

Service — Class in namespace OpenStack\Metric\v1\Gnocchi

Gnocci Metric v1 Service class

Service::searchResources() — Method in class Service

Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format.

$FixedIp — Property in class FixedIp

$FloatingIp — Property in class FloatingIp

$Router — Property in class Router

Service — Class in namespace OpenStack\Networking\v2\Extensions\Layer3

SecurityGroup — Class in namespace OpenStack\Networking\v2\Extensions\SecurityGroups\Models

Represents a SecurityGroup resource in the Network v2 service

$SecurityGroup — Property in class SecurityGroup

SecurityGroupRule — Class in namespace OpenStack\Networking\v2\Extensions\SecurityGroups\Models

Represents a SecurityGroupRule resource in the Network v2 service

$SecurityGroupRule — Property in class SecurityGroupRule

Service — Class in namespace OpenStack\Networking\v2\Extensions\SecurityGroups

$InterfaceAttachment — Property in class InterfaceAttachment

$InterfaceAttachment — Property in class InterfaceAttachment

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerPool — Property in class LoadBalancerPool

$Network — Property in class Network

$Network — Property in class Network

$Network — Property in class Network

$Port — Property in class Port

The port status. Value is ACTIVE or DOWN.

$Port — Property in class Port

The UUIDs of any attached security groups.

$Quota — Property in class Quota

$Quota — Property in class Quota

$Quota — Property in class Quota

$Quota — Property in class Quota

Subnet — Class in namespace OpenStack\Networking\v2\Models

Represents a Networking v2 Network.

Service — Class in namespace OpenStack\Networking\v2

Network v2 service for OpenStack.

Service — Class in namespace OpenStack\ObjectStore\v1

T

$QuotaSet — Property in class QuotaSet

$Volume — Property in class Volume

Operation::toParamArray() — Method in class Operation

A convenience method that will take a generic array of data and convert it into an array of {see Parameter} objects.

Token — Class in namespace OpenStack\Common\Auth

$QuotaSet — Property in class QuotaSet

The UUID of the tenant/user the quotas listed for.

$Server — Property in class Server

$Server — Property in class Server

$Entry — Property in class Entry

Tenant — Class in namespace OpenStack\Identity\v2\Models

Represents an Identity v2 Tenant.

Token — Class in namespace OpenStack\Identity\v2\Models

Represents an Identity v2 Token.

$Token — Property in class Token

$Credential — Property in class Credential

$Policy — Property in class Policy

$Service — Property in class Service

Token — Class in namespace OpenStack\Identity\v3\Models

$Image — Property in class Image

$Resource — Property in class Resource

$FloatingIp — Property in class FloatingIp

$Router — Property in class Router

$SecurityGroup — Property in class SecurityGroup

$SecurityGroupRule — Property in class SecurityGroupRule

$LoadBalancer — Property in class LoadBalancer

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

$LoadBalancerListener — Property in class LoadBalancerListener

$LoadBalancerMember — Property in class LoadBalancerMember

$LoadBalancerPool — Property in class LoadBalancerPool

$LoadBalancerStat — Property in class LoadBalancerStat

$Network — Property in class Network

$Port — Property in class Port

The UUID of the tenant who owns the network. Only administrative users can specify a tenant UUID other than their own.

$Quota — Property in class Quota

$Subnet — Property in class Subnet

$Account — Property in class Account

U

QuotaSet::update() — Method in class QuotaSet

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

Snapshot::update() — Method in class Snapshot

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

Volume::update() — Method in class Volume

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

VolumeType::update() — Method in class VolumeType

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

Builder::userInputError() — Method in class Builder

Helper method responsible for constructing and returning {see UserInputError} exceptions.

UserInputError — Class in namespace OpenStack\Common\Error

Represents a user input error, caused by an incorrect type or malformed value.

Updateable — Class in namespace OpenStack\Common\Resource

Represents a resource that can be updated.

Updateable::update() — Method in class Updateable

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

Utils — Class in namespace OpenStack\Common\Transport

$Image — Property in class Image

$Keypair — Property in class Keypair

QuotaSet::update() — Method in class QuotaSet

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

$Server — Property in class Server

$Server — Property in class Server

Server::update() — Method in class Server

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

Server::unrescue() — Method in class Server

Unrescues the server.

$Assignment — Property in class Assignment

$Credential — Property in class Credential

Credential::update() — Method in class Credential

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

Domain::update() — Method in class Domain

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

$Endpoint — Property in class Endpoint

Endpoint::update() — Method in class Endpoint

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

Group::update() — Method in class Group

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

$Policy — Property in class Policy

Policy::update() — Method in class Policy

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

Project::update() — Method in class Project

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

Service::update() — Method in class Service

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

$Token — Property in class Token

User — Class in namespace OpenStack\Identity\v3\Models

User::update() — Method in class User

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

$Image — Property in class Image

Image::update() — Method in class Image

Image::uploadData() — Method in class Image

$Member — Property in class Member

Member::updateStatus() — Method in class Member

$Metric — Property in class Metric

$Resource — Property in class Resource

FloatingIp::update() — Method in class FloatingIp

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

Router::update() — Method in class Router

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

SecurityGroup::update() — Method in class SecurityGroup

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

LoadBalancer::update() — Method in class LoadBalancer

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

$LoadBalancerHealthMonitor — Property in class LoadBalancerHealthMonitor

LoadBalancerHealthMonitor::update() — Method in class LoadBalancerHealthMonitor

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

LoadBalancerListener::update() — Method in class LoadBalancerListener

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

LoadBalancerMember::update() — Method in class LoadBalancerMember

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

LoadBalancerPool::update() — Method in class LoadBalancerPool

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

Network::update() — Method in class Network

{@inheritDoc}

Port::update() — Method in class Port

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

Quota::update() — Method in class Quota

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

Subnet::update() — Method in class Subnet

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

V

$QuotaSet — Property in class QuotaSet

$QuotaSet — Property in class QuotaSet

$Snapshot — Property in class Snapshot

Volume — Class in namespace OpenStack\BlockStorage\v2\Models

$Volume — Property in class Volume

$Volume — Property in class Volume

VolumeAttachment — Class in namespace OpenStack\BlockStorage\v2\Models

$VolumeAttachment — Property in class VolumeAttachment

VolumeType — Class in namespace OpenStack\BlockStorage\v2\Models

Operation::validate() — Method in class Operation

This method will validate all of the user-provided values and throw an exception if any failures are detected. This is useful for basic sanity-checking before a request is serialized and sent to the API.

Parameter::validate() — Method in class Parameter

Validates a given user value and checks whether it passes basic sanity checking, such as types.

Schema::validate() — Method in class Schema

$Flavor — Property in class Flavor

$Hypervisor — Property in class Hypervisor

$Hypervisor — Property in class Hypervisor

$HypervisorStatistic — Property in class HypervisorStatistic

$HypervisorStatistic — Property in class HypervisorStatistic

$Server — Property in class Server

Service::validateToken() — Method in class Service

Validates a token, identified by its ID, and returns TRUE if its valid, FALSE if not.

$Image — Property in class Image

$Image — Property in class Image

$LoadBalancer — Property in class LoadBalancer

$LoadBalancer — Property in class LoadBalancer

W

HasWaiterTrait::waitUntil() — Method in class HasWaiterTrait

Provides a blocking operation until the resource has reached a particular state. The method will enter a loop, requesting feedback from the remote API until it sends back an appropriate status.

HasWaiterTrait::waitWithCallback() — Method in class HasWaiterTrait

Provides a blocking operation until the resource has reached a particular state. The method will enter a loop, executing the callback until TRUE is returned. This provides great flexibility.

HasWaiterTrait::waitUntilActive() — Method in class HasWaiterTrait

Convenience method providing a blocking operation until the resource transitions to an ACTIVE status.

HasWaiterTrait::waitUntilDeleted() — Method in class HasWaiterTrait

$LoadBalancerMember — Property in class LoadBalancerMember

Z

$Host — Property in class Host

_

Operation::__construct() — Method in class Operation

OperatorInterface::__construct() — Method in class OperatorInterface

OperatorTrait::__construct() — Method in class OperatorTrait

{@inheritDoc}

OperatorTrait::__debugInfo() — Method in class OperatorTrait

Magic method for dictating how objects are rendered when var_dump is called.

OperatorTrait::__call() — Method in class OperatorTrait

Magic method which intercepts async calls, finds the sequential version, and wraps it in a {see Promise} object. In order for this to happen, the called methods need to be in the following format: createAsync, where create is the sequential method being wrapped.

Parameter::__construct() — Method in class Parameter

AuthHandler::__construct() — Method in class AuthHandler

AuthHandler::__invoke() — Method in class AuthHandler

This method is invoked before every HTTP request is sent to the API. When this happens, it checks to see whether a token is set and valid, and then sets the X-Auth-Token header for the HTTP request before letting it continue on its merry way.

Builder::__construct() — Method in class Builder

JsonPath::__construct() — Method in class JsonPath

Schema::__construct() — Method in class Schema

Alias::__construct() — Method in class Alias

Iterator::__construct() — Method in class Iterator

Iterator::__invoke() — Method in class Iterator

Builder::__construct() — Method in class Builder

RequestSerializer::__construct() — Method in class RequestSerializer

Schema::__construct() — Method in class Schema

OpenStack::__construct() — Method in class OpenStack