| Server IP : 78.140.185.180 / Your IP : 216.73.216.169 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/./././www/vendor/rackspace/php-opencloud/lib/OpenCloud/Compute/Resource/ |
Upload File : |
<?php
/**
* Copyright 2012-2014 Rackspace US, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace OpenCloud\Compute\Resource;
use OpenCloud\Common\Resource\NovaResource;
use OpenCloud\DNS\Resource\HasPtrRecordsInterface;
use OpenCloud\Image\Resource\ImageInterface;
use OpenCloud\Networking\Resource\NetworkInterface;
use OpenCloud\Networking\Resource\SecurityGroup;
use OpenCloud\Networking\Resource\Port;
use OpenCloud\Volume\Resource\Volume;
use OpenCloud\Common\Exceptions;
use OpenCloud\Common\Http\Message\Formatter;
use OpenCloud\Common\Lang;
use OpenCloud\Compute\Constants\ServerState;
use OpenCloud\Compute\Service;
/**
* A virtual machine (VM) instance in the Cloud Servers environment.
*
* @note This implementation supports extension attributes OS-DCF:diskConfig,
* RAX-SERVER:bandwidth, rax-bandwidth:bandwidth.
*/
class Server extends NovaResource implements HasPtrRecordsInterface
{
/**
* The server status. {@see \OpenCloud\Compute\Constants\ServerState} for supported types.
*
* @var string
*/
public $status;
/**
* @var string The time stamp for the last update.
*/
public $updated;
/**
* The compute provisioning algorithm has an anti-affinity property that
* attempts to spread customer VMs across hosts. Under certain situations,
* VMs from the same customer might be placed on the same host. $hostId
* represents the host your server runs on and can be used to determine this
* scenario if it is relevant to your application.
*
* @var string
*/
public $hostId;
/**
* @var type Public and private IP addresses for this server.
*/
public $addresses;
/**
* @var array Server links.
*/
public $links;
/**
* The Image for this server.
*
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html
* @var ImageInterface
*/
public $image;
/**
* The bootable volume for this server.
*
* @var Volume
*/
public $volume;
/**
* Whether to delete the bootable volume when the server is terminated (deleted).
* @var boolean
*/
public $volumeDeleteOnTermination;
/**
* The Flavor for this server.
*
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html
* @var type
*/
public $flavor;
/**
* @var type
*/
public $networks = array();
/**
* Security groups for this server. An array of either the names or SecurityGroup objects.
* @var (string|SecurityGroup)[]
*/
public $security_groups = array();
/**
* @var string The server ID.
*/
public $id;
/**
* @var string The user ID.
*/
public $user_id;
/**
* @var string The server name.
*/
public $name;
/**
* @var string The time stamp for the creation date.
*/
public $created;
/**
* @var string The tenant ID.
*/
public $tenant_id;
/**
* @var string The public IP version 4 access address.
*/
public $accessIPv4;
/**
* @var string The public IP version 6 access address.
*/
public $accessIPv6;
/**
* The build completion progress, as a percentage. Value is from 0 to 100.
* @var int
*/
public $progress;
/**
* @var string The root password (only populated on server creation).
*/
public $adminPass;
/**
* @var mixed Metadata key and value pairs.
*/
public $metadata;
/**
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ext_status.html
* @var string Virtual machine status.
*/
public $extendedStatus;
/**
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ext_status.html
* @var string Status indicating a running task
*/
public $taskStatus;
/**
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ext_status.html
* @var int Power status of the VM
*/
public $powerStatus;
/**
* @link http://developer.openstack.org/api-ref-compute-v2-ext.html#ext-os-ext-az
* @var string Availability zone of the VM
*/
public $availabilityZone;
protected static $json_name = 'server';
protected static $url_resource = 'servers';
/** @var string|object Keypair or string representation of keypair name */
public $keypair;
/**
* @var array Uploaded file attachments
*/
private $personality = array();
/**
* @var type Image reference (for create)
*/
private $imageRef;
/**
* @var type Flavor reference (for create)
*/
private $flavorRef;
/**
* Cloud-init boot executable code
* @var string
*/
public $user_data;
/**
* {@inheritDoc}
*/
protected $aliases = array(
'OS-EXT-STS:vm_state' => 'extendedStatus',
'OS-EXT-STS:task_state' => 'taskStatus',
'OS-EXT-STS:power_state' => 'powerStatus',
'OS-EXT-AZ:availability_zone' => 'availabilityZone'
);
/**
* Creates a new Server object and associates it with a Compute service
*
* @param mixed $info
* * If NULL, an empty Server object is created
* * If an object, then a Server object is created from the data in the
* object
* * If a string, then it's treated as a Server ID and retrieved from the
* service
* The normal use case for SDK clients is to treat it as either NULL or an
* ID. The object value parameter is a special case used to construct
* a Server object from a ServerList element to avoid a secondary
* call to the Service.
* @throws ServerNotFound if a 404 is returned
* @throws UnknownError if another error status is reported
*/
public function __construct(Service $service, $info = null)
{
// make the service persistent
parent::__construct($service, $info);
// the metadata item is an object, not an array
$this->metadata = $this->metadata();
}
/**
* Returns the primary external IP address of the server
*
* This function is based upon the accessIPv4 and accessIPv6 values.
* By default, these are set to the public IP address of the server.
* However, these values can be modified by the user; this might happen,
* for example, if the server is behind a firewall and needs to be
* routed through a NAT device to be reached.
*
* @api
* @param integer $type the type of IP version (4 or 6) to return
* @return string IP address
*/
public function ip($type = null)
{
switch ($type) {
default:
case 4:
$value = $this->accessIPv4;
break;
case 6:
$value = $this->accessIPv6;
break;
}
return $value;
}
/**
* {@inheritDoc}
*/
public function create($params = array())
{
$this->id = null;
$this->status = null;
if (isset($params['imageId'])) {
$this->imageRef = $params['imageId'];
}
if (isset($params['flavorId'])) {
$this->flavorRef = $params['flavorId'];
}
return parent::create($params);
}
/**
* Rebuilds an existing server
*
* @api
* @param array $params - an associative array of key/value pairs of
* attributes to set on the new server
*/
public function rebuild($params = array())
{
if (!isset($params['adminPass'])) {
throw new Exceptions\RebuildError(
Lang::Translate('adminPass required when rebuilding server')
);
}
if (!isset($params['image'])) {
throw new Exceptions\RebuildError(
Lang::Translate('image required when rebuilding server')
);
}
$object = (object) array(
'rebuild' => (object) array(
'imageRef' => $params['image']->id(),
'adminPass' => $params['adminPass'],
'name' => (array_key_exists('name', $params) ? $params['name'] : $this->name)
)
);
return $this->action($object);
}
/**
* Reboots a server
*
* A "soft" reboot requests that the operating system reboot itself; a "hard" reboot is the equivalent of pulling
* the power plug and then turning it back on, with a possibility of data loss.
*
* @api
* @param string $type A particular reboot State. See Constants\ServerState for string values.
* @return \Guzzle\Http\Message\Response
*/
public function reboot($type = null)
{
if (!$type) {
$type = ServerState::REBOOT_STATE_HARD;
}
$object = (object) array('reboot' => (object) array('type' => $type));
return $this->action($object);
}
/**
* Creates a new image from a server
*
* @api
* @param string $name The name of the new image
* @param array $metadata Optional metadata to be stored on the image
* @return boolean|Image New Image instance on success; FALSE on failure
* @throws Exceptions\ImageError
*/
public function createImage($name, $metadata = array())
{
if (empty($name)) {
throw new Exceptions\ImageError(
Lang::translate('Image name is required to create an image')
);
}
// construct a createImage object for jsonization
$object = (object) array('createImage' => (object) array(
'name' => $name,
'metadata' => (object) $metadata
));
$response = $this->action($object);
if (!$response || !($location = $response->getHeader('Location'))) {
return false;
}
return new Image($this->getService(), basename($location));
}
/**
* Schedule daily image backups
*
* @api
* @param mixed $retention - false (default) indicates you want to
* retrieve the image schedule. $retention <= 0 indicates you
* want to delete the current schedule. $retention > 0 indicates
* you want to schedule image backups and you would like to
* retain $retention backups.
* @return mixed an object or FALSE on error
* @throws Exceptions\ServerImageScheduleError if an error is encountered
*/
public function imageSchedule($retention = false)
{
$url = $this->getUrl('rax-si-image-schedule');
if ($retention === false) {
// Get current retention
$request = $this->getClient()->get($url);
} elseif ($retention <= 0) {
// Delete image schedule
$request = $this->getClient()->delete($url);
} else {
// Set image schedule
$object = (object) array('image_schedule' =>
(object) array('retention' => $retention)
);
$body = json_encode($object);
$request = $this->getClient()->post($url, self::getJsonHeader(), $body);
}
$body = Formatter::decode($request->send());
return (isset($body->image_schedule)) ? $body->image_schedule : (object) array();
}
/**
* Initiates the resize of a server
*
* @api
* @param Flavor $flavorRef a Flavor object indicating the new server size
* @return boolean TRUE on success; FALSE on failure
*/
public function resize(Flavor $flavorRef)
{
// construct a resize object for jsonization
$object = (object) array(
'resize' => (object) array('flavorRef' => $flavorRef->id)
);
return $this->action($object);
}
/**
* confirms the resize of a server
*
* @api
* @return boolean TRUE on success; FALSE on failure
*/
public function resizeConfirm()
{
$object = (object) array('confirmResize' => null);
$response = $this->action($object);
$this->refresh($this->id);
return $response;
}
/**
* reverts the resize of a server
*
* @api
* @return boolean TRUE on success; FALSE on failure
*/
public function resizeRevert()
{
$object = (object) array('revertResize' => null);
return $this->action($object);
}
/**
* Sets the root password on the server
*
* @api
* @param string $newPassword The new root password for the server
* @return boolean TRUE on success; FALSE on failure
*/
public function setPassword($newPassword)
{
$object = (object) array(
'changePassword' => (object) array('adminPass' => $newPassword)
);
return $this->action($object);
}
/**
* Puts the server into *rescue* mode
*
* @api
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/rescue_mode.html
* @return string the root password of the rescue server
* @throws Exceptions\ServerActionError if the server has no ID (i.e., has not
* been created yet)
*/
public function rescue()
{
$this->checkExtension('os-rescue');
if (empty($this->id)) {
throw new Exceptions\ServerActionError(
Lang::translate('Server has no ID; cannot Rescue()')
);
}
$data = (object) array('rescue' => 'none');
$response = $this->action($data);
$body = Formatter::decode($response);
return (isset($body->adminPass)) ? $body->adminPass : false;
}
/**
* Takes the server out of RESCUE mode
*
* @api
* @link http://docs.rackspace.com/servers/api/v2/cs-devguide/content/rescue_mode.html
* @return HttpResponse
* @throws Exceptions\ServerActionError if the server has no ID (i.e., has not
* been created yet)
*/
public function unrescue()
{
$this->checkExtension('os-rescue');
if (!isset($this->id)) {
throw new Exceptions\ServerActionError(Lang::translate('Server has no ID; cannot Unescue()'));
}
$object = (object) array('unrescue' => null);
return $this->action($object);
}
/**
* Retrieves the metadata associated with a Server.
*
* If a metadata item name is supplied, then only the single item is
* returned. Otherwise, the default is to return all metadata associated
* with a server.
*
* @api
* @param string $key - the (optional) name of the metadata item to return
* @return ServerMetadata object
* @throws Exceptions\MetadataError
*/
public function metadata($key = null)
{
return new ServerMetadata($this, $key);
}
/**
* Returns the IP address block for the Server or for a specific network.
*
* @api
* @param string $network - if supplied, then only the IP(s) for the
* specified network are returned. Otherwise, all IPs are returned.
* @return object
* @throws Exceptions\ServerIpsError
*/
public function ips($network = null)
{
$url = Lang::noslash($this->Url('ips/' . $network));
$response = $this->getClient()->get($url)->send();
$body = Formatter::decode($response);
return (isset($body->addresses)) ? $body->addresses :
((isset($body->network)) ? $body->network : (object) array());
}
/**
* Attaches a volume to a server
*
* Requires the os-volumes extension. This is a synonym for
* `VolumeAttachment::create()`
*
* @api
* @param OpenCloud\Volume\Resource\Volume $volume The volume to attach. If
* "auto" is specified (the default), then the first available
* device is used to mount the volume (for example, if the primary
* disk is on `/dev/xvhda`, then the new volume would be attached
* to `/dev/xvhdb`).
* @param string $device the device to which to attach it
*/
public function attachVolume(Volume $volume, $device = 'auto')
{
$this->checkExtension('os-volumes');
return $this->volumeAttachment()->create(array(
'volumeId' => $volume->id,
'device' => ($device == 'auto' ? null : $device)
));
}
/**
* Removes a volume attachment from a server
*
* Requires the os-volumes extension. This is a synonym for
* `VolumeAttachment::delete()`
* @param OpenCloud\Volume\Resource\Volume $volume The volume to remove
*/
public function detachVolume(Volume $volume)
{
$this->checkExtension('os-volumes');
return $this->volumeAttachment($volume->id)->delete();
}
/**
* Returns a VolumeAttachment object
*
*/
public function volumeAttachment($id = null)
{
$resource = new VolumeAttachment($this->getService());
$resource->setParent($this)->populate($id);
return $resource;
}
/**
* Returns a Collection of VolumeAttachment objects
* @return Collection
*/
public function volumeAttachmentList()
{
return $this->getService()->collection(
'OpenCloud\Compute\Resource\VolumeAttachment', null, $this
);
}
/**
* Adds a "personality" file to be uploaded during create() or rebuild()
*
* @api
* @param string $path The path where the file will be stored on the
* target server (up to 255 characters)
* @param string $data the file contents (max size set by provider)
* @return void
*/
public function addFile($path, $data)
{
$this->personality[$path] = base64_encode($data);
}
/**
* Returns a console connection
* Note: Where is this documented?
*
* @codeCoverageIgnore
*/
public function console($type = 'novnc')
{
$action = (strpos('spice', $type) !== false) ? 'os-getSPICEConsole' : 'os-getVNCConsole';
$object = (object) array($action => (object) array('type' => $type));
$response = $this->action($object);
$body = Formatter::decode($response);
return (isset($body->console)) ? $body->console : false;
}
protected function createJson()
{
// Convert some values
$this->metadata->sdk = $this->getService()->getClient()->getUserAgent();
if ($this->image instanceof ImageInterface) {
$this->imageRef = $this->image->getId();
}
if ($this->flavor instanceof Flavor) {
$this->flavorRef = $this->flavor->id;
}
// Base object
$server = (object) array(
'name' => $this->name,
'imageRef' => $this->imageRef,
'flavorRef' => $this->flavorRef
);
if ($this->metadata->count()) {
$server->metadata = $this->metadata->toArray();
}
// Boot from volume
if ($this->volume instanceof Volume) {
$this->checkExtension('os-block-device-mapping-v2-boot');
$server->block_device_mapping_v2 = array();
$server->block_device_mapping_v2[] = (object) array(
'source_type' => 'volume',
'destination_type' => 'volume',
'uuid' => $this->volume->id,
'boot_index' => 0,
'delete_on_termination' => (boolean) $this->volumeDeleteOnTermination
);
}
// Networks
if (is_array($this->networks) && count($this->networks)) {
$server->networks = array();
foreach ($this->networks as $network) {
if ($network instanceof NetworkInterface) {
$server->networks[] = (object) array('uuid' => $network->getId());
} elseif ($network instanceof Port) {
$server->networks[] = (object) array('port' => $network->getId());
} else {
throw new Exceptions\InvalidParameterError(sprintf(
'When creating a server, the "networks" key must be an ' .
'array of objects which implement either OpenCloud\Networking\Resource\NetworkInterface ' .
'or OpenCloud\Networking\Resource\Port. The variable you passed in was a [%s]',
gettype($network)
));
}
}
}
// Security groups
if (is_array($this->security_groups) && count($this->security_groups)) {
$server->security_groups = array();
foreach ($this->security_groups as $security_group) {
if ($security_group instanceof SecurityGroup) {
$securityGroupName = $security_group->name();
} elseif (is_string($security_group)) {
$securityGroupName = $security_group;
} else {
throw new Exceptions\InvalidParameterError(sprintf(
'When creating a server, the "security_groups" key must be an ' .
'array of strings or objects of type OpenCloud\Networking\Resource\SecurityGroup;' .
'variable passed in was a [%s]',
gettype($security_group)
));
}
$server->security_groups[] = (object) array('name' => $securityGroupName);
}
}
// Personality files
if (!empty($this->personality)) {
$server->personality = array();
foreach ($this->personality as $path => $data) {
// Stock personality array
$server->personality[] = (object) array(
'path' => $path,
'contents' => $data
);
}
}
// Keypairs
if (!empty($this->keypair)) {
if (is_string($this->keypair)) {
$server->key_name = $this->keypair;
} elseif (isset($this->keypair['name']) && is_string($this->keypair['name'])) {
$server->key_name = $this->keypair['name'];
} elseif ($this->keypair instanceof Keypair && $this->keypair->getName()) {
$server->key_name = $this->keypair->getName();
}
}
// Cloud-init executable
if (!empty($this->user_data)) {
$server->user_data = $this->user_data;
}
// Availability zone
if (!empty($this->availabilityZone)) {
$this->checkExtension('OS-EXT-AZ');
$server->availability_zone = $this->availabilityZone;
}
return (object) array('server' => $server);
}
protected function updateJson($params = array())
{
return (object) array('server' => (object) $params);
}
/**
* Suspend a server
*
* A suspend request suspend an instance, its VM state is stored on disk, all memory is written
* to disk, and the virtual machine is stopped. Suspending an instance is similar to placing a
* device in hibernation; memory and vCPUs become available to create other instances.
*
* @api
* @return \Guzzle\Http\Message\Response
*/
public function suspend()
{
// The suspend action is only available when the os-admin-actions extension is installed.
$this->checkExtension('os-admin-actions');
$object = (object) array('suspend' => 'none');
return $this->action($object);
}
/**
* Resume a server
*
* A resume request resumes a suspended instance, its VM state was stored on disk, all memory was written
* to disk, and the virtual machine was stopped. Resuming a suspended instance is similar to resuming a
* device from hibernation.
*
* @api
* @return \Guzzle\Http\Message\Response
*/
public function resume()
{
// The resume action is only available when the os-admin-actions extension is installed.
$this->checkExtension('os-admin-actions');
$object = (object) array('resume' => 'none');
return $this->action($object);
}
/**
* Get server diagnostics
*
* Gets basic usage data for a specified server.
*
* @api
* @return object
*/
public function diagnostics()
{
// The diagnostics is only available when the os-server-diagnostics extension is installed.
$this->checkExtension('os-server-diagnostics');
$url = $this->getUrl('diagnostics');
$response = $this->getClient()->get($url)->send();
$body = Formatter::decode($response);
return $body ?: (object) array();
}
/**
* Start a server
*
* Starts a stopped server and changes its status to ACTIVE.
*
* @api
* @return \Guzzle\Http\Message\Response
*/
public function start()
{
// The start action is only available when the os-server-start-stop extension is installed.
$this->checkExtension('os-server-start-stop');
$object = (object) array('os-start' => null);
return $this->action($object);
}
/**
* Stop a server
*
* Stops a running server and changes its status to STOPPED.
*
* @api
* @return \Guzzle\Http\Message\Response
*/
public function stop()
{
// The stop action is only available when the os-server-start-stop extension is installed.
$this->checkExtension('os-server-start-stop');
$object = (object) array('os-stop' => null);
return $this->action($object);
}
}