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

Service

class Service extends AbstractService

Traits

OpenStack\Common\Api\OperatorTrait

Methods

createVolume (array $userOptions) : Volume

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

listVolumes (bool $detail = false, array $userOptions = array()) : Generator

Lists all available volumes.

getVolume (string $volumeId) : Volume

No description

createVolumeType (array $userOptions) : VolumeType

No description

listVolumeTypes () : Generator

No description

getVolumeType (string $typeId) : VolumeType

No description

createSnapshot (array $userOptions) : Snapshot

No description

listSnapshots (bool $detail = false, array $userOptions = array()) : Generator

No description

getSnapshot (string $snapshotId) : Snapshot

No description

getQuotaSet (string $tenantId) : QuotaSet

Shows A Quota for a tenant

Details

View source
createVolume(array $userOptions)

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

You must have enough volume storage quota remaining to create a volume of size requested.

Parameters

$userOptions array {see Api::postVolumes}

Return value

Volume

Example code

$volume = $service->createVolume($userOptions);

View source
listVolumes(bool $detail = false, array $userOptions = array())

Lists all available volumes.

Parameters

$detail bool If set to TRUE, more information will be returned.
$userOptions array {see Api::getVolumes}

Return value

Generator

Example code

$generator = $service->listVolumes($detail, $userOptions);

View source
getVolume(string $volumeId)

Parameters

$volumeId string The UUID of the volume being retrieved.

Return value

Volume

Example code

$volume = $service->getVolume($volumeId);

View source
createVolumeType(array $userOptions)

Parameters

$userOptions array {see Api::postTypes}

Return value

VolumeType

Example code

$volumeType = $service->createVolumeType($userOptions);

View source
listVolumeTypes()

Return value

Generator

Example code

$generator = $service->listVolumeTypes();

View source
getVolumeType(string $typeId)

Parameters

$typeId string

Return value

VolumeType

Example code

$volumeType = $service->getVolumeType($typeId);

View source
createSnapshot(array $userOptions)

Parameters

$userOptions array {see Api::postSnapshots}

Return value

Snapshot

Example code

$snapshot = $service->createSnapshot($userOptions);

View source
listSnapshots(bool $detail = false, array $userOptions = array())

Parameters

$detail bool
$userOptions array

Return value

Generator

Example code

$generator = $service->listSnapshots($detail, $userOptions);

View source
getSnapshot(string $snapshotId)

Parameters

$snapshotId string

Return value

Snapshot

Example code

$snapshot = $service->getSnapshot($snapshotId);

View source
getQuotaSet(string $tenantId)

Shows A Quota for a tenant

Parameters

$tenantId string

Return value

QuotaSet

Example code

$quotaSet = $service->getQuotaSet($tenantId);