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

\network

+

Network Class of the back-end application

+

Management of Networks

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ create_network()
+ create_subnet()
+ list_network_ids()
+ list_network_names()
+ list_cidr()
+ getNetwork()
+ getNetworkP()
+ getSubnet()
+ getSubnetP()
+ updateNetwork()
+ updateSubnet()
+ deleteNetwork()
+ deleteSubnet()
+ createPort()
+ listPorts()
+ getPort()
+ getPortP()
+ updatePort()
+ deletePort()
+ createSecurityGroup()
+ createSecurityGroupRule()
+ listSecurityGroupe()
+ listSecurityGroupeRule()
+ getSecurityGroupe()
+ getSecurityGroupeP()
+ deleteSecurityGroupe()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

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

$libClass

+ 
$libClass : \OpenStack\Network
+

+ + +

Type

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

Methods

+ +
+ +
+
+ +
+

__construct()

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

Network constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \network + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

create_network()

+ + 
create_network() : void
+

Create a new network

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

create_subnet()

+ + 
create_subnet() : void
+

Create a new subnet

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

list_network_ids()

+ + 
list_network_ids() : void
+

List the ID of the NETWORKS

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

list_network_names()

+ + 
list_network_names() : \List
+

List the name of the NETWORKS

+ + + + +

Returns

+ \List + —

of Networks name

+ +
+
+ +
+ +
+
+ +
+

list_cidr()

+ + 
list_cidr() : void
+

List the CIDR of the SUBNETS

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

getNetwork()

+ + 
getNetwork() : void
+

retrieve a specific network

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

getNetworkP()

+ + 
getNetworkP(  $netId) : \OpenStack\Network
+

internal function

+ + +

Parameters

+ + + + + + +
$netId
+ + +

Returns

+ \OpenStack\Network + +
+
+ +
+ +
+
+ +
+

getSubnet()

+ + 
getSubnet() : void
+

retrieve a specific subnet

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

getSubnetP()

+ + 
getSubnetP(  $subnetId) : \OpenStack\Subnet
+

internal function

+ + +

Parameters

+ + + + + + +
$subnetId
+ + +

Returns

+ \OpenStack\Subnet + +
+
+ +
+ +
+
+ +
+

updateNetwork()

+ + 
updateNetwork() : void
+

Update a network given

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

updateSubnet()

+ + 
updateSubnet() : void
+

Update a subnet given

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

deleteNetwork()

+ + 
deleteNetwork() : void
+

Delete a network given

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

deleteSubnet()

+ + 
deleteSubnet() : void
+

Delete a subnet given

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

createPort()

+ + 
createPort() : void
+

Create a new port

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

listPorts()

+ + 
listPorts() : void
+

List the of ports

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

getPort()

+ + 
getPort() : void
+

retrieve a specific port given

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

getPortP()

+ + 
getPortP(  $portId) : \port
+

internal function

+

retrieve a specific port given

+ +

Parameters

+ + + + + + +
$portId
+ + +

Returns

+ \port + +
+
+ +
+ +
+
+ +
+

updatePort()

+ + 
updatePort() : void
+

Update port given

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

deletePort()

+ + 
deletePort() : void
+

Delete a port given

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

createSecurityGroup()

+ + 
createSecurityGroup() : void
+

Create a new security groupe

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

createSecurityGroupRule()

+ + 
createSecurityGroupRule() : void
+

Create a new security groupe

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

listSecurityGroupe()

+ + 
listSecurityGroupe() : void
+

List of Security Groupes

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

listSecurityGroupeRule()

+ + 
listSecurityGroupeRule() : void
+

List of Security Groupe Rules

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

getSecurityGroupe()

+ + 
getSecurityGroupe() : void
+

retrieve a specific Security Groupe given

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

getSecurityGroupeP()

+ + 
getSecurityGroupeP(  $securityGroupeId) : \securityGroup
+

internal function

+

retrieve a specific Security Groupe given

+ +

Parameters

+ + + + + + +
$securityGroupeId
+ + +

Returns

+ \securityGroup + +
+
+ +
+ +
+
+ +
+

deleteSecurityGroupe()

+ + 
deleteSecurityGroupe() : void
+

Delete a specific Security Groupe given

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