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/networkLayer3.html | 743 ++++++++++++++++++++++++++++++++++ 1 file changed, 743 insertions(+) create mode 100644 server/doc/classes/networkLayer3.html (limited to 'server/doc/classes/networkLayer3.html') diff --git a/server/doc/classes/networkLayer3.html b/server/doc/classes/networkLayer3.html new file mode 100644 index 0000000..2b36a19 --- /dev/null +++ b/server/doc/classes/networkLayer3.html @@ -0,0 +1,743 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\networkLayer3

+

networkLayer3 Class of the back-end application

+

Management of networkLayer3

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ listFloatingIp()
+ createFloatingIp()
+ getFloatingIp()
+ updateFloatingIp()
+ deleteFloatingIp()
+ retrieveFloatingIp()
+ createRouter()
+ listRouters()
+ getRouter()
+ deleteRouter()
+ updateRouter()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

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

$libClass

+ 
$libClass : \OpenStack\NetworkLayer3
+

+ + +

Type

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

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \networkLayer3
+

networkLayer3 constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \networkLayer3 + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

listFloatingIp()

+ + 
listFloatingIp() : void
+

List floatingip

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

createFloatingIp()

+ + 
createFloatingIp() : void
+

Create a new floating IP adress

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

getFloatingIp()

+ + 
getFloatingIp() : void
+

Show floatingip details

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

updateFloatingIp()

+ + 
updateFloatingIp() : void
+

Update floating ip

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

deleteFloatingIp()

+ + 
deleteFloatingIp() : void
+

Delete a floating ip

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

retrieveFloatingIp()

+ + 
retrieveFloatingIp() : void
+

Retrieve a floating ip

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

createRouter()

+ + 
createRouter() : void
+

Create a new router

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

listRouters()

+ + 
listRouters() : void
+

List routers

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

getRouter()

+ + 
getRouter() : void
+

Show router details

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

deleteRouter()

+ + 
deleteRouter() : void
+

Delete a router

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

updateRouter()

+ + 
updateRouter() : void
+

Update router

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