1. class
  2. OpenStack
  3. Compute
  4. v2
  5. Models
  6. Server

Server

class Server extends OperatorResource implements Creatable, Updateable, Deletable, Retrievable, Listable

Traits

OpenStack\Common\Resource\HasWaiterTrait
Contains reusable functionality for resources that have long operations which require waiting in order to reach a particular state.
OpenStack\Common\Api\OperatorTrait

Properties

$id string
$ipv4 string
$ipv6 string
$addresses array
$created DateTimeImmutable
$updated DateTimeImmutable
$flavor Flavor
$hostId string
$hypervisorHostname string
$image Image
$links
$metadata array
$name string
$progress string
$status string
$tenantId string
$userId string
$adminPass string
$taskState string
$powerState string
$vmState string
$fault Fault

Methods

create (array $userOptions) : Creatable

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

update () : void

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

delete () : void

Permanently delete this resource.

retrieve () : void

Retrieve details of the current resource from the remote API.

changePassword (string $newPassword)

Changes the root password for a server.

reboot (string $type = Enum::REBOOT_SOFT)

Reboots the server.

start ()

Starts server

stop ()

Stops server

rebuild (array $options)

Rebuilds the server.

rescue (array $options) : string

Rescues the server.

unrescue ()

Unrescues the server.

resize (string $flavorId)

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

confirmResize ()

Confirms a previous resize operation.

revertResize ()

Reverts a previous resize operation.

getVncConsole (string $type = Enum::CONSOLE_NOVNC) : array

Gets a VNC console for a server.

getRDPConsole (string $type = Enum::CONSOLE_RDP_HTML5) : array

Gets a RDP console for a server.

getSpiceConsole (string $type = Enum::CONSOLE_SPICE_HTML5) : array

Gets a Spice console for a server.

getSerialConsole (string $type = Enum::CONSOLE_SERIAL) : array

Gets a serial console for a server.

createImage (array $options)

Creates an image for the current server.

listAddresses (array $options = array()) : array

Iterates over all the IP addresses for this server.

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

Returns Generator for InterfaceAttachment

getInterfaceAttachment (string $portId) : InterfaceAttachment

Gets an interface attachment.

createInterfaceAttachment (array $userOptions) : InterfaceAttachment

Creates an interface attachment.

detachInterface (string $portId)

Detaches an interface attachment.

getMetadata () : array

Retrieves metadata from the API.

resetMetadata (array $metadata)

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

mergeMetadata (array $metadata) : array

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.

getMetadataItem (string $key) : mixed

Retrieve the value for a specific metadata key.

deleteMetadataItem (string $key)

Remove a specific metadata key.

addSecurityGroup (array $options) : SecurityGroup

Add security group to a server (addSecurityGroup action)

removeSecurityGroup (array $options)

Add security group to a server (addSecurityGroup action)

parseMetadata (ResponseInterface $response)

No description

listSecurityGroups () : Generator

Returns Generator for SecurityGroups

listVolumeAttachments () : Generator

Returns Generator for VolumeAttachment

attachVolume (string $volumeId) : VolumeAttachment

Attach a volume and returns volume that was attached

detachVolume (string $attachmentId) : void

Detach a volume

Details

View source
create(array $userOptions)

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

Parameters

$userOptions array {see \OpenStack\Compute\v2\Api::postServer}

Return value

Creatable

Example code

$creatable = $server->create($userOptions);

View source
update()

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

Return value

void

Example code

$server->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$server->delete();

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$server->retrieve();

View source
changePassword(string $newPassword)

Changes the root password for a server.

Parameters

$newPassword string The new root password

Example code

$server->changePassword($newPassword);

View source
reboot(string $type = Enum::REBOOT_SOFT)

Reboots the server.

Parameters

$type string The type of reboot that will be performed. Either SOFT or HARD is supported.

Example code

$server->reboot($type);

View source
start()

Starts server

Example code

$server->start();

View source
stop()

Stops server

Example code

$server->stop();

View source
rebuild(array $options)

Rebuilds the server.

Parameters

$options array {see \OpenStack\Compute\v2\Api::rebuildServer}

Example code

$server->rebuild($options);

View source
rescue(array $options)

Rescues the server.

Parameters

$options array {see \OpenStack\Compute\v2\Api::rescueServer}

Return value

string

Example code

$string = $server->rescue($options);

View source
unrescue()

Unrescues the server.

Example code

$server->unrescue();

View source
resize(string $flavorId)

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

Parameters

$flavorId string The UUID of the new flavor your server will be based on.

Example code

$server->resize($flavorId);

View source
confirmResize()

Confirms a previous resize operation.

Example code

$server->confirmResize();

View source
revertResize()

Reverts a previous resize operation.

Example code

$server->revertResize();

View source
getVncConsole(string $type = Enum::CONSOLE_NOVNC)

Gets a VNC console for a server.

Parameters

$type string The type of VNC console: novnc|xvpvnc. Defaults to novnc.

Return value

array

Example code

$array = $server->getVncConsole($type);

View source
getRDPConsole(string $type = Enum::CONSOLE_RDP_HTML5)

Gets a RDP console for a server.

Parameters

$type string The type of VNC console: rdp-html5 (default).

Return value

array

Example code

$array = $server->getRDPConsole($type);

View source
getSpiceConsole(string $type = Enum::CONSOLE_SPICE_HTML5)

Gets a Spice console for a server.

Parameters

$type string The type of VNC console: spice-html5.

Return value

array

Example code

$array = $server->getSpiceConsole($type);

View source
getSerialConsole(string $type = Enum::CONSOLE_SERIAL)

Gets a serial console for a server.

Parameters

$type string The type of VNC console: serial.

Return value

array

Example code

$array = $server->getSerialConsole($type);

View source
createImage(array $options)

Creates an image for the current server.

Parameters

$options array {see \OpenStack\Compute\v2\Api::createServerImage}

Example code

$server->createImage($options);

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

Iterates over all the IP addresses for this server.

Parameters

$options array {see \OpenStack\Compute\v2\Api::getAddressesByNetwork}

Return value

array An array containing to two keys: "public" and "private"

Example code

$array = $server->listAddresses($options);

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

Returns Generator for InterfaceAttachment

Parameters

$options array

Return value

Generator

Example code

$generator = $server->listInterfaceAttachments($options);

View source
getInterfaceAttachment(string $portId)

Gets an interface attachment.

Parameters

$portId string The unique ID of the port.

Return value

InterfaceAttachment

Example code

$interfaceAttachment = $server->getInterfaceAttachment($portId);

View source
createInterfaceAttachment(array $userOptions)

Creates an interface attachment.

Parameters

$userOptions array {see \OpenStack\Compute\v2\Api::postInterfaceAttachment}

Return value

InterfaceAttachment

Example code

$interfaceAttachment = $server->createInterfaceAttachment($userOptions);

View source
detachInterface(string $portId)

Detaches an interface attachment.

Parameters

$portId string

Example code

$server->detachInterface($portId);

View source
getMetadata()

Retrieves metadata from the API.

Return value

array

Example code

$array = $server->getMetadata();

View source
resetMetadata(array $metadata)

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

Parameters

$metadata array {see \OpenStack\Compute\v2\Api::putServerMetadata}

Example code

$server->resetMetadata($metadata);

View source
mergeMetadata(array $metadata)

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.

Parameters

$metadata array {see \OpenStack\Compute\v2\Api::postServerMetadata}

Return value

array

Example code

$array = $server->mergeMetadata($metadata);

View source
getMetadataItem(string $key)

Retrieve the value for a specific metadata key.

Parameters

$key string {see \OpenStack\Compute\v2\Api::getServerMetadataKey}

Return value

mixed

Example code

$mixed = $server->getMetadataItem($key);

View source
deleteMetadataItem(string $key)

Remove a specific metadata key.

Parameters

$key string {see \OpenStack\Compute\v2\Api::deleteServerMetadataKey}

Example code

$server->deleteMetadataItem($key);

View source
addSecurityGroup(array $options)

Add security group to a server (addSecurityGroup action)

Parameters

$options array {see \OpenStack\Compute\v2\Api::postSecurityGroup}

Return value

SecurityGroup

Example code

$securityGroup = $server->addSecurityGroup($options);

View source
removeSecurityGroup(array $options)

Add security group to a server (addSecurityGroup action)

Parameters

$options array {see \OpenStack\Compute\v2\Api::deleteSecurityGroup}

Example code

$server->removeSecurityGroup($options);

View source
parseMetadata(ResponseInterface $response)

Parameters

$response ResponseInterface

Example code

$server->parseMetadata($response);

View source
listSecurityGroups()

Returns Generator for SecurityGroups

Return value

Generator

Example code

$generator = $server->listSecurityGroups();

View source
listVolumeAttachments()

Returns Generator for VolumeAttachment

Return value

Generator

Example code

$generator = $server->listVolumeAttachments();

View source
attachVolume(string $volumeId)

Attach a volume and returns volume that was attached

Parameters

$volumeId string

Return value

VolumeAttachment

Example code

$volumeAttachment = $server->attachVolume($volumeId);

View source
detachVolume(string $attachmentId)

Detach a volume

Parameters

$attachmentId string

Return value

void

Example code

$server->detachVolume($attachmentId);