fgcp.connection
index
connection.py

XML-RPC Connection with the Fujitsu Global Cloud Platform (FGCP) API Server
 
Example: [not recommended, use API Commands, Resource Actions and/or Client Methods instead]
 
# Connect with your client certificate to region 'uk'
from fgcp.connection import FGCPProxyServer
xmlrpc_proxy = FGCPProxyServer('client.pem', 'uk')
 
# Send XML-RPC actions, request parameters and attachments
vsystems = xmlrpc_proxy.do_action('ListVSYS')
for vsys in vsystems:
    status = xmlrpc_proxy.do_action('GetVSYSStatus', {'vsysId': vsys.vsysId})
    vsysconfig = xmlrpc_proxy.do_action('GetVSYSConfiguration', {'vsysId': vsys.vsysId})
    for vserver in vsysconfig.vservers:
        status = xmlrpc_proxy.do_action('GetVServerStatus', {'vsysId': vsys.vsysId, 'vserverId': vserver.vserverId})
    ...

 
Modules
       
xml.etree.ElementTree
base64
tlslite.utils.keyfactory
os
time

 
Classes
       
fgcp.FGCPError(exceptions.Exception)
FGCPResponseError
future.types.newobject.newobject(__builtin__.object)
FGCPConnection
FGCPProxyServer
FGCPResponseParser

 
class FGCPConnection(future.types.newobject.newobject)
    FGCP XML-RPC Connection
 
 
Method resolution order:
FGCPConnection
future.types.newobject.newobject
__builtin__.object

Methods defined here:
__init__(self, key_file='client.pem', region='de', verbose=0, debug=0, conn=None)
Use the same PEM file for SSL client certificate and RSA key signature
 
Note: to convert your .p12 or .pfx file to unencrypted PEM format, you can use
the following 'openssl' command:
 
openssl pkcs12 -in UserCert.p12 -out client.pem -nodes
__repr__(self)
add_param(self, key=None, value=None, depth=0)
close(self)
connect(self)
do_action(self, action, params=None, attachments=None)
Send the XML-RPC request and get the response
get_accesskeyid(self)
# see com.fujitsu.oviss.pub.OViSSSignature
get_body(self, action, params=None, attachments=None)
get_headers(self, attachments=None)
get_signature(self, acc=None)
# see com.fujitsu.oviss.pub.OViSSSignature
receive(self)
send(self, method, uri, body, headers)
set_conn(self, conn)
set_key(self, key_string)
set_region(self, region)

Data and other attributes defined here:
api_version = '2015-01-30'
debug = 0
key_file = 'client.pem'
locale = 'en'
region = 'de'
timezone = 'Central European Time'
uri = '/ovissapi/endpoint'
user_agent = 'OViSS-API-CLIENT'
verbose = 0

Methods inherited from future.types.newobject.newobject:
__long__(self)
__native__(self)
Hook for the future.utils.native() function
__nonzero__(self)
__unicode__(self)
next(self)

Data descriptors inherited from future.types.newobject.newobject:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class FGCPProxyServer(FGCPConnection)
    FGCP XML-RPC Proxy Server
 
 
Method resolution order:
FGCPProxyServer
FGCPConnection
future.types.newobject.newobject
__builtin__.object

Methods inherited from FGCPConnection:
__init__(self, key_file='client.pem', region='de', verbose=0, debug=0, conn=None)
Use the same PEM file for SSL client certificate and RSA key signature
 
Note: to convert your .p12 or .pfx file to unencrypted PEM format, you can use
the following 'openssl' command:
 
openssl pkcs12 -in UserCert.p12 -out client.pem -nodes
__repr__(self)
add_param(self, key=None, value=None, depth=0)
close(self)
connect(self)
do_action(self, action, params=None, attachments=None)
Send the XML-RPC request and get the response
get_accesskeyid(self)
# see com.fujitsu.oviss.pub.OViSSSignature
get_body(self, action, params=None, attachments=None)
get_headers(self, attachments=None)
get_signature(self, acc=None)
# see com.fujitsu.oviss.pub.OViSSSignature
receive(self)
send(self, method, uri, body, headers)
set_conn(self, conn)
set_key(self, key_string)
set_region(self, region)

Data and other attributes inherited from FGCPConnection:
api_version = '2015-01-30'
debug = 0
key_file = 'client.pem'
locale = 'en'
region = 'de'
timezone = 'Central European Time'
uri = '/ovissapi/endpoint'
user_agent = 'OViSS-API-CLIENT'
verbose = 0

Methods inherited from future.types.newobject.newobject:
__long__(self)
__native__(self)
Hook for the future.utils.native() function
__nonzero__(self)
__unicode__(self)
next(self)

Data descriptors inherited from future.types.newobject.newobject:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class FGCPResponseError(fgcp.FGCPError)
    
Method resolution order:
FGCPResponseError
fgcp.FGCPError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from fgcp.FGCPError:
__init__(self, status, message)
__str__(self)

Data descriptors inherited from fgcp.FGCPError:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class FGCPResponseParser(future.types.newobject.newobject)
    FGCP Response Parser
 
 
Method resolution order:
FGCPResponseParser
future.types.newobject.newobject
__builtin__.object

Methods defined here:
clean_tag(self, tag)
Return the tag without namespace
get_tag_object(self, tag)
parse_data(self, data, proxy)
Load the data as XML ElementTree and convert to FGCP Response
xmlelement_to_object(self, root=None, parent=None)
Convert the XML Element to an FGCP Element

Methods inherited from future.types.newobject.newobject:
__long__(self)
__native__(self)
Hook for the future.utils.native() function
__nonzero__(self)
__unicode__(self)
next(self)

Data descriptors inherited from future.types.newobject.newobject:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
print_function = _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 65536)