From f4d12bf72a943d6a8965f21a11eefbb05d2a5483 Mon Sep 17 00:00:00 2001 From: Eole Date: Wed, 27 Apr 2016 22:52:25 +0200 Subject: Add Documentation --- server/doc/classes/compute.html | 881 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 881 insertions(+) create mode 100644 server/doc/classes/compute.html (limited to 'server/doc/classes/compute.html') diff --git a/server/doc/classes/compute.html b/server/doc/classes/compute.html new file mode 100644 index 0000000..e6bd0ed --- /dev/null +++ b/server/doc/classes/compute.html @@ -0,0 +1,881 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\compute

+

Compute Class of the back-end application

+

Management of Servers

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+ listServers()
+ listFlavors()
+ listImages()
+ getServer()
+ getFlavor()
+ getImage()
+ createServer()
+ updateServer()
+ deleteServer()
+ changePassword()
+ reboot()
+ rebuild()
+ resize()
+ confirmResize()
+ revertResize()
+ listAddresses()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ +
+
+ +
+

$libClass

+ 
$libClass : \OpenStack\Compute
+

+ + +

Type

+ \OpenStack\Compute + — protected, contains the library Compute object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(  $app) : \compute
+

Compute constructor

+ + +

Parameters

+ + + + + + +
$app
+ + +

Returns

+ \compute + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

+ + + +
+
+ +
+ +
+
+ +
+

listServers()

+ + 
listServers() : void
+

List servers.

+ + + + + +
+
+ +
+ +
+
+ +
+

listFlavors()

+ + 
listFlavors() : void
+

List flavors.

+ + + + + +
+
+ +
+ +
+
+ +
+

listImages()

+ + 
listImages() : void
+

List images.

+ + + + + +
+
+ +
+ +
+
+ +
+

getServer()

+ + 
getServer() : void
+

Get server details.

+ + + + + +
+
+ +
+ +
+
+ +
+

getFlavor()

+ + 
getFlavor() : void
+

Get flavor details.

+ + + + + +
+
+ +
+ +
+
+ +
+

getImage()

+ + 
getImage() : array
+

Get image details.

+ + + + +

Returns

+ array + +
+
+ +
+ +
+
+ +
+

createServer()

+ + 
createServer() : void
+

Create server.

+ + + + + +
+
+ +
+ +
+
+ +
+

updateServer()

+ + 
updateServer() : void
+

update a server

+ + + + + +
+
+ +
+ +
+
+ +
+

deleteServer()

+ + 
deleteServer() : void
+

Delete a server

+ + + + + +
+
+ +
+ +
+
+ +
+

changePassword()

+ + 
changePassword() : void
+

Change the password of a server

+ + + + + +
+
+ +
+ +
+
+ +
+

reboot()

+ + 
reboot() : void
+

Reboot a server

+ + + + + +
+
+ +
+ +
+
+ +
+

rebuild()

+ + 
rebuild() : void
+

Rebuild a server

+ + + + + +
+
+ +
+ +
+
+ +
+

resize()

+ + 
resize() : void
+

Resize a server

+

A call to this method has to be followed by either confirmResize or revertResize

+ + + + +
+
+ +
+ +
+
+ +
+

confirmResize()

+ + 
confirmResize() : void
+

Confirm resize operation on a server

+ + + + + +
+
+ +
+ +
+
+ +
+

revertResize()

+ + 
revertResize() : void
+

Revert resize operation on a server

+ + + + + +
+
+ +
+ +
+
+ +
+

listAddresses()

+ + 
listAddresses() : void
+

List private and public addresses of a server

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + -- cgit v1.2.3