Service/Rackspace/Servers.php

Show:

inherited

Classes
- \Zend_Service_Rackspace_Servers

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Rackspace

\Zend_Service_Rackspace_Servers
jump to top

Package: Default

Parent(s): \Zend_Service_Rackspace_Abstract

Constants

 
                LIMIT_FILE_SIZE
                = 10240

 
                LIMIT_NUM_FILE
                = 5

 
                ERROR_SERVICE_UNAVAILABLE
                = 'The service is unavailable'

 
                ERROR_UNAUTHORIZED
                = 'Unauthorized'

 
                ERROR_OVERLIMIT
                = 'You reached the limit of requests, please wait some time before retry'

 
                ERROR_PARAM_NO_ID
                = 'You must specify the item\'s id'

 
                ERROR_PARAM_NO_NAME
                = 'You must specify the name'

 
                ERROR_PARAM_NO_SERVERID
                = 'You must specify the server Id'

 
                ERROR_PARAM_NO_IMAGEID
                = 'You must specify the server\'s image ID'

 
                ERROR_PARAM_NO_FLAVORID
                = 'You must specify the server\'s flavor ID'

 
                ERROR_PARAM_NO_ARRAY
                = 'You must specify an array of parameters'

 
                ERROR_PARAM_NO_WEEKLY
                = 'You must specify a weekly backup schedule'

 
                ERROR_PARAM_NO_DAILY
                = 'You must specify a daily backup schedule'

 
                ERROR_ITEM_NOT_FOUND
                = 'The item specified doesn\'t exist.'

 
                ERROR_NO_FILE_EXISTS
                = 'The file specified doesn\'t exist'

 
                ERROR_LIMIT_FILE_SIZE
                = 'You reached the size length of a file'

 
                ERROR_IN_PROGRESS
                = 'The item specified is still in progress'

 
                ERROR_BUILD_IN_PROGRESS
                = 'The build is still in progress'

 
                ERROR_RESIZE_NOT_ALLOWED
                = 'The resize is not allowed'

 
                VERSION
                = 'v1.0'

inheritedInherited from: \Zend_Service_Rackspace_Abstract::VERSION

Inherited_from: \Zend_Service_Rackspace_Abstract::VERSION

 
                US_AUTH_URL
                = 'https://auth.api.rackspacecloud.com'

inheritedInherited from: \Zend_Service_Rackspace_Abstract::US_AUTH_URL

Inherited_from: \Zend_Service_Rackspace_Abstract::US_AUTH_URL

 
                UK_AUTH_URL
                = 'https://lon.auth.api.rackspacecloud.com'

inheritedInherited from: \Zend_Service_Rackspace_Abstract::UK_AUTH_URL

Inherited_from: \Zend_Service_Rackspace_Abstract::UK_AUTH_URL

 
                API_FORMAT
                = 'json'

inheritedInherited from: \Zend_Service_Rackspace_Abstract::API_FORMAT

Inherited_from: \Zend_Service_Rackspace_Abstract::API_FORMAT

 
                USER_AGENT
                = 'Zend_Service_Rackspace'

inheritedInherited from: \Zend_Service_Rackspace_Abstract::USER_AGENT

Inherited_from: \Zend_Service_Rackspace_Abstract::USER_AGENT

 
                STORAGE_URL
                = "X-Storage-Url"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::STORAGE_URL

Inherited_from: \Zend_Service_Rackspace_Abstract::STORAGE_URL

 
                AUTHTOKEN
                = "X-Auth-Token"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHTOKEN

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHTOKEN

 
                AUTHUSER_HEADER
                = "X-Auth-User"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHUSER_HEADER

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHUSER_HEADER

 
                AUTHKEY_HEADER
                = "X-Auth-Key"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHKEY_HEADER

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHKEY_HEADER

 
                AUTHUSER_HEADER_LEGACY
                = "X-Storage-User"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHUSER_HEADER_LEGACY

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHUSER_HEADER_LEGACY

 
                AUTHKEY_HEADER_LEGACY
                = "X-Storage-Pass"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHKEY_HEADER_LEGACY

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHKEY_HEADER_LEGACY

 
                AUTHTOKEN_LEGACY
                = "X-Storage-Token"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::AUTHTOKEN_LEGACY

Inherited_from: \Zend_Service_Rackspace_Abstract::AUTHTOKEN_LEGACY

 
                CDNM_URL
                = "X-CDN-Management-Url"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::CDNM_URL

Inherited_from: \Zend_Service_Rackspace_Abstract::CDNM_URL

 
                MANAGEMENT_URL
                = "X-Server-Management-Url"

inheritedInherited from: \Zend_Service_Rackspace_Abstract::MANAGEMENT_URL

Inherited_from: \Zend_Service_Rackspace_Abstract::MANAGEMENT_URL

Properties

string $authUrl =

inherited

Authentication URL

Inherited from: \Zend_Service_Rackspace_Abstract::$$authUrl

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$authUrl

string $cdnUrl =

inherited

CDN URL

Inherited from: \Zend_Service_Rackspace_Abstract::$$cdnUrl

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$cdnUrl

string $errorCode =

inherited

HTTP error code

Inherited from: \Zend_Service_Rackspace_Abstract::$$errorCode

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$errorCode

string $errorMsg =

inherited

Error Msg

Inherited from: \Zend_Service_Rackspace_Abstract::$$errorMsg

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$errorMsg

\Zend_Http_Client $httpClient =

inherited

Inherited from: \Zend_Service_Rackspace_Abstract::$$httpClient

Details

Type: \Zend_Http_Client
Inherited_from: \Zend_Service_Rackspace_Abstract::$$httpClient

string $key =

inherited

Rackspace Key

Inherited from: \Zend_Service_Rackspace_Abstract::$$key

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$key

string $managementUrl =

inherited

Server management URL

Inherited from: \Zend_Service_Rackspace_Abstract::$$managementUrl

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$managementUrl

string $storageUrl =

inherited

Storage URL

Inherited from: \Zend_Service_Rackspace_Abstract::$$storageUrl

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$storageUrl

string $token =

inherited

Token of authentication

Inherited from: \Zend_Service_Rackspace_Abstract::$$token

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$token

boolean $useServiceNet = false

inherited

Do we use ServiceNet?

Inherited from: \Zend_Service_Rackspace_Abstract::$$useServiceNet

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Service_Rackspace_Abstract::$$useServiceNet

string $user =

inherited

Rackspace account name

Inherited from: \Zend_Service_Rackspace_Abstract::$$user

Details

Type: string
Inherited_from: \Zend_Service_Rackspace_Abstract::$$user

Methods

__construct(string $user, string $key, string $authUrl = self::US_AUTH_URL) : void

inherited

Constructor

Inherited from: \Zend_Service_Rackspace_Abstract::__construct()

You must pass the account and the Rackspace authentication key. Optional: the authentication url (default is US)

Parameters

Name	Type	Description
$user	string
$key	string
$authUrl	string

authenticate() : boolean

inherited

Authentication

Inherited from: \Zend_Service_Rackspace_Abstract::authenticate()

Returns

Type	Description
boolean

changeBackupSchedule(string $id, string $weekly, string $daily) : boolean

Change the backup schedule of a server

Parameters

Name	Type	Description
$id	string	server's Id
$weekly	string
$daily	string

Returns

Type	Description
boolean

changeServerName(string $id, string $name) : boolean

Change the server's name

Parameters

Name	Type	Description
$id	string
$name	string

Returns

Type	Description
boolean

changeServerPassword(string $id, string $password) : boolean

Change the admin password of the server

Parameters

Name	Type	Description
$id	string
$password	string

Returns

Type	Description
boolean

confirmResizeServer(string $id) : boolean

Confirm resize of a server

During a resize operation, the original server is saved for a period of time to allow roll back if there is a problem. Once the newly resized server is tested and has been confirmed to be functioning properly, use this operation to confirm the resize. After confirmation, the original server is removed and cannot be rolled back to. All resizes are automatically confirmed after 24 hours if they are not explicitly confirmed or reverted.

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
boolean

createImage(string $serverId, string $name) : \Zend_Service_Rackspace_Servers_Image

Create an image for a serverId

Parameters

Name	Type	Description
$serverId	string
$name	string

Returns

Type	Description
\Zend_Service_Rackspace_Servers_Image

createServer(array $data, array $metadata = array(), array $files = array()) : \Zend_Service_Rackspace_Servers_Server | boolean

Create a new server

The required parameters are specified in $data (name, imageId, falvorId) The $files is an associative array with 'serverPath' => 'localPath'

Parameters

Name	Type	Description
$data	array
$metadata	array
$files	array

Returns

Type	Description
\Zend_Service_Rackspace_Servers_Server \| boolean

createSharedIpGroup(string $name, string $serverId) : array | boolean

Create a shared Ip group

Parameters

Name	Type	Description
$name	string
$serverId	string

Returns

Type	Description
array \| boolean

deleteImage(string $id) : boolean

Delete an image

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
boolean

deleteServer(string $id) : boolean

Delete a server

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
boolean

deleteSharedIpGroup(integer $id) : boolean

Delete a Shared Ip Group

Parameters

Name	Type	Description
$id	integer

Returns

Type	Description
boolean

disableBackupSchedule(string $id) : boolean

Disable the backup schedule for a server

Parameters

Name	Type	Description
$id	string	server's Id

Returns

Type	Description
boolean

getAuthUrl() : string

inherited

Get authentication URL

Inherited from: \Zend_Service_Rackspace_Abstract::getAuthUrl()

Returns

Type	Description
string

getBackupSchedule(string $id) : array | boolean

Get the backup schedule of a server

Parameters

Name	Type	Description
$id	string	server's Id

Returns

Type	Description
array \| boolean

getCdnUrl() : string | boolean

inherited

Get the CDN URL

Inherited from: \Zend_Service_Rackspace_Abstract::getCdnUrl()

Returns

Type	Description
string \| boolean

getErrorCode() : \strig

inherited

Get the error code of the last HTTP call

Inherited from: \Zend_Service_Rackspace_Abstract::getErrorCode()

Returns

Type	Description
\strig

getErrorMsg() : string

inherited

Get the error msg of the last HTTP call

Inherited from: \Zend_Service_Rackspace_Abstract::getErrorMsg()

Returns

Type	Description
string

getFlavor(string $flavorId) : array | boolean

Get the detail of a flavor

Parameters

Name	Type	Description
$flavorId	string

Returns

Type	Description
array \| boolean

getHttpClient() : \Zend_Http_Client

inherited

get the HttpClient instance

Inherited from: \Zend_Service_Rackspace_Abstract::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getImage(string $id) : \Zend_Service_Rackspace_Servers_Image | boolean

Get detail about an image

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
\Zend_Service_Rackspace_Servers_Image \| boolean

getKey() : string

inherited

Get user key

Inherited from: \Zend_Service_Rackspace_Abstract::getKey()

Returns

Type	Description
string

getManagementUrl() : string | boolean

inherited

Get the management server URL

Inherited from: \Zend_Service_Rackspace_Abstract::getManagementUrl()

Returns

Type	Description
string \| boolean

getServer(string $id) : \Zend_Service_Rackspace_Servers_Server

Get the specified server

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
\Zend_Service_Rackspace_Servers_Server

getServerIp(string $id) : array | boolean

Get the server's IPs (public and private)

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
array \| boolean

getServerPrivateIp(string $id) : array | boolean

Get the Private IPs of a server

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
array \| boolean

getServerPublicIp(string $id) : array | boolean

Get the Public IPs of a server

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
array \| boolean

getServiceNet() : boolean

inherited

Get whether we're using ServiceNet

Inherited from: \Zend_Service_Rackspace_Abstract::getServiceNet()

Returns

Type	Description
boolean

getSharedIpGroup(integer $id) : \Zend_Service_Rackspace_Servers_SharedIpGroup | boolean

Get the shared IP group

Parameters

Name	Type	Description
$id	integer

Returns

Type	Description
\Zend_Service_Rackspace_Servers_SharedIpGroup \| boolean

getStorageUrl() : string | boolean

inherited

Get the storage URL

Inherited from: \Zend_Service_Rackspace_Abstract::getStorageUrl()

Returns

Type	Description
string \| boolean

getToken() : string

inherited

Get the authentication token

Inherited from: \Zend_Service_Rackspace_Abstract::getToken()

Returns

Type	Description
string

getUser() : string

inherited

Get User account

Inherited from: \Zend_Service_Rackspace_Abstract::getUser()

Returns

Type	Description
string

httpCall(string $url, string $method, array $headers = array(),  $data = array(), string $body = null) : \Zend_Http_Response

inherited

HTTP call

Inherited from: \Zend_Service_Rackspace_Abstract::httpCall()

Parameters

Name	Type	Description
$url	string
$method	string
$headers	array
$data
$body	string

Returns

Type	Description
\Zend_Http_Response

isSuccessful() : boolean

inherited

Return true is the last call was successful

Inherited from: \Zend_Service_Rackspace_Abstract::isSuccessful()

Returns

Type	Description
boolean

listFlavors(boolean $details = false) : array | boolean

Get the list of the flavors

If $details is true returns detail info

Parameters

Name	Type	Description
$details	boolean

Returns

Type	Description
array \| boolean

listImages(boolean $details = false) : \Zend_Service_Rackspace_Servers_ImageList | boolean

Get the list of the images

Parameters

Name	Type	Description
$details	boolean

Returns

Type	Description
\Zend_Service_Rackspace_Servers_ImageList \| boolean

listServers(boolean $details = false) : \Zend_Service_Rackspace_Servers_ServerList | boolean

Get the list of the servers If $details is true returns detail info

Parameters

Name	Type	Description
$details	boolean

Returns

Type	Description
\Zend_Service_Rackspace_Servers_ServerList \| boolean

listSharedIpGroups(boolean $details = false) : \Zend_Service_Rackspace_Servers_SharedIpGroupList | boolean

Get the list of shared IP groups

Parameters

Name	Type	Description
$details	boolean

Returns

Type	Description
\Zend_Service_Rackspace_Servers_SharedIpGroupList \| boolean

rebootServer(string $id, boolean $hard = false) : boolean

Reboot a server

$hard true is the equivalent of power cycling the server $hard false is a graceful shutdown

Parameters

Name	Type	Description
$id	string
$hard	boolean

Returns

Type	Description
boolean

rebuildServer(string $id, string $imageId) : boolean

Rebuild a server

The rebuild function removes all data on the server and replaces it with the specified image, serverId and IP addresses will remain the same.

Parameters

Name	Type	Description
$id	string
$imageId	string

Returns

Type	Description
boolean

resizeServer(string $id, string $flavorId) : boolean

Resize a server

The resize function converts an existing server to a different flavor, in essence, scaling the server up or down. The original server is saved for a period of time to allow rollback if there is a problem. All resizes should be tested and explicitly confirmed, at which time the original server is removed. All resizes are automatically confirmed after 24 hours if they are not explicitly confirmed or reverted.

Parameters

Name	Type	Description
$id	string
$flavorId	string

Returns

Type	Description
boolean

revertResizeServer(string $id) : boolean

Revert resize of a server

During a resize operation, the original server is saved for a period of time to allow for roll back if there is a problem. If you determine there is a problem with a newly resized server, use this operation to revert the resize and roll back to the original server. All resizes are automatically confirmed after 24 hours if they have not already been confirmed explicitly or reverted.

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
boolean

setAuthUrl(string $url) : void

inherited

Set the Authentication URL

Inherited from: \Zend_Service_Rackspace_Abstract::setAuthUrl()

Parameters

Name	Type	Description
$url	string

setKey(string $key) : void

inherited

Set the authentication key

Inherited from: \Zend_Service_Rackspace_Abstract::setKey()

Parameters

Name	Type	Description
$key	string

setServiceNet(boolean $useServiceNet = true) : void

inherited

Sets whether to use ServiceNet

Inherited from: \Zend_Service_Rackspace_Abstract::setServiceNet()

ServiceNet is Rackspace's internal network. Bandwidth on ServiceNet is not charged.

Parameters

Name	Type	Description
$useServiceNet	boolean

setUser(string $user) : void

inherited

Set the user account

Inherited from: \Zend_Service_Rackspace_Abstract::setUser()

Parameters

Name	Type	Description
$user	string

shareIpAddress(string $id, string $ip, string $groupId, $configure = true) : boolean

Share an ip address for a server (id)

Parameters

Name	Type	Description
$id	string	server
$ip	string
$groupId	string
$configure

Returns

Type	Description
boolean

unshareIpAddress(string $id, string $ip) : boolean

Unshare IP address for a server ($id)

Parameters

Name	Type	Description
$id	string
$ip	string

Returns

Type	Description
boolean

updateServer(string $id, string $name = null, string $password = null) : boolean

Change the name or the admin password for a server

Parameters

Name	Type	Description
$id	string
$name	string
$password	string

Returns

Type	Description
boolean

Service/Rackspace/Servers.php

\Zend_Service_Rackspace_Serversjump to top

Constants

Properties

Methods

\Zend_Service_Rackspace_Servers
jump to top