FIM Client API

Eclipse fog05 FIM Client API

FIMAPI

class fog05.fimapi.FIMAPI(locator='127.0.0.1:7447', sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: FIMAPI

This class implements the API to interact with Eclipse fog05 FIM

Attributes:

descriptor : Descriptor

Gives access to the descriptor API

node : Node

Gives access to the node API

plugin : Plugin

Gives access to the plugin API

network : Network

Gives access to the descriptor API

fdu : FDUAPI

Gives access to the FDU API

image : Image

Gives access to the image API

flavor : Flavor

Gives access to the flavor API

Descriptor

class fog05.fimapi.FIMAPI.Descriptor

Class: Descriptor

This class encapsulates API for descriptors

Methods

Type	Descriptor types
check(self, descriptor, descriptor_type)	Checks the given descriptor

class Type

Descriptor types

check(self, descriptor, descriptor_type)

Checks the given descriptor

Parameters:

descriptor : dictionary

the descriptor to be checked

descriptor_type : API.Descriptor.Type

type of descriptor

Returns:

bool

Node

class fog05.fimapi.FIMAPI.Node(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: Node This class encapsulates API for Nodes

Methods

info(self, node_uuid)	Provides all information about the given node
list(self)	Gets all nodes in the current system/tenant
plugins(self, node_uuid)	Gets the list of plugins in the given node
search(self, search_dict)	Searches for nodes that satisfies the parameter
status(self, node_uuid)	Provides all status information about the given node,

info(self, node_uuid)

Provides all information about the given node

Parameters:

node_uuid : string

UUID of the node

Returns:

dictionary

list(self)

Gets all nodes in the current system/tenant

Returns:

string list

plugins(self, node_uuid)

Gets the list of plugins in the given node

Parameters:

node_uuid : string

UUID of the node

Returns:

string list

search(self, search_dict)

Searches for nodes that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

Returns:

string list

status(self, node_uuid)

Provides all status information about the given node,

Parameters:

node_uuid : string

UUID of the node

Returns:

dictionary

Plugin

class fog05.fimapi.FIMAPI.Plugin(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: Plugin This class encapsulates API for Plugins

Methods

add(self, descriptor, node_uuid)	Adds the given plugin to the given node
info(self, plugin_uuid, node_uuid)	Gets information about the given plugin in the given node
remove(self, plugin_uuid, node_uuid)	Removes the given plugin from the given node
search(self, search_dict[, node_uuid])	Searches for plugin that satisfies the parameter

add(self, descriptor, node_uuid)

Adds the given plugin to the given node

Parameters:

descriptor : dictionary

the plugin descriptor

node_uuid : string

UUID of the node

Returns:

bool

info(self, plugin_uuid, node_uuid)

Gets information about the given plugin in the given node

Parameters:

plugin_uuid : string

UUID of the plugin

node_uuid : string

UUID of the node

Returns:

dictionary

remove(self, plugin_uuid, node_uuid)

Removes the given plugin from the given node

Parameters:

plugin_uuid : string

UUID of the plugin

node_uuid : string

UUID of the node

Returns:

bool

search(self, search_dict, node_uuid=None)

Searches for plugin that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

node_uuid : string

optional node UUID where search

Returns:

string list

Network

class fog05.fimapi.FIMAPI.Plugin(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: Plugin This class encapsulates API for Plugins

Methods

add(self, descriptor, node_uuid)	Adds the given plugin to the given node
info(self, plugin_uuid, node_uuid)	Gets information about the given plugin in the given node
remove(self, plugin_uuid, node_uuid)	Removes the given plugin from the given node
search(self, search_dict[, node_uuid])	Searches for plugin that satisfies the parameter

add(self, descriptor, node_uuid)

Adds the given plugin to the given node

Parameters:

descriptor : dictionary

the plugin descriptor

node_uuid : string

UUID of the node

Returns:

bool

info(self, plugin_uuid, node_uuid)

Gets information about the given plugin in the given node

Parameters:

plugin_uuid : string

UUID of the plugin

node_uuid : string

UUID of the node

Returns:

dictionary

remove(self, plugin_uuid, node_uuid)

Removes the given plugin from the given node

Parameters:

plugin_uuid : string

UUID of the plugin

node_uuid : string

UUID of the node

Returns:

bool

search(self, search_dict, node_uuid=None)

Searches for plugin that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

node_uuid : string

optional node UUID where search

Returns:

string list

FDUAPI

class fog05.fimapi.FIMAPI.FDUAPI(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: FDUAPI This class encapsulates API for FDUs

Methods

clean(self, instanceid[, wait])	Cleans the given instance
configure(self, instanceid[, wait])	Configures the given instance
define(self, fduid, node_uuid[, wait])	Defines the given fdu in the given node
get_nodes(self, fdu_uuid)	Gets all the node in which the given FDU is running
info(self, fdu_uuid)	Gets information about the given FDU from the catalog
instance_info(self, instanceid)	Gets information about the given instance
instance_list(self, fduid)	Gets all the instances of a given FDU
instantiate(self, fduid, nodeid[, wait])	Instantiates the given fdu in the given node
list(self)	Gets all the FDUs registered in the catalog
list_node(self, node_uuid)	Gets all the FDUs running in the given node
migrate(self, instanceid, destination_node_uuid)	Migrates the given instance
offload(self, fdu_uuid)	Removes the given FDU from the system catalog Needs at least one node in the system!
onboard(self, descriptor)	Registers an FDU descriptor in the system catalog Needs at least one node in the system!
pause(self, instanceid[, wait])	Pauses the given instance
resume(self, instanceid[, wait])	Resumes the given instance
search(self, search_dict[, node_uuid])	Searches for flavors that satisfies the parameter
start(self, instanceid[, wait])	Starts the given instance
stop(self, instanceid[, wait])	Stops the given instance
terminate(self, instanceid[, wait])	Terminates the given instance
undefine(self, instanceid)	Undefines the given instance

clean(self, instanceid, wait=True)

Cleans the given instance

Returns:

string

configure(self, instanceid, wait=True)

Configures the given instance

Returns:

string

define(self, fduid, node_uuid, wait=True)

Defines the given fdu in the given node

Instance UUID is system-wide unique

Parameters:

fduid : string

UUID of the FDU

node_uuid : string

UUID of the node

wait : bool

optional, call will block until FDU is defined

returns

——-

InfraFDU

get_nodes(self, fdu_uuid)

Gets all the node in which the given FDU is running

Parameters:

fdu_uuid : string

UUID of the FDU

Returns:

string list

info(self, fdu_uuid)

Gets information about the given FDU from the catalog

Parameters:

fdu_uuid : string

UUID of the FDU

Returns:

FDU

instance_info(self, instanceid)

Gets information about the given instance

Parameters:

instanceid : string

UUID of the instance

Returns:

InfraFDU

instance_list(self, fduid)

Gets all the instances of a given FDU

Parameters:

fduid : string

UUID of the FDU

Returns:

dictionary

{node_id: [instances list]}

instantiate(self, fduid, nodeid, wait=True)

Instantiates the given fdu in the given node

This functions calls: define, configure, start

Instance UUID is system-wide unique

Parameters:

fduid : string

UUID of the FDU

node_uuid : string

UUID of the node

wait : bool

optional, call will block until FDU is defined

Returns:

InfraFDU

list(self)

Gets all the FDUs registered in the catalog

Returns:

string list

list_node(self, node_uuid)

Gets all the FDUs running in the given node

node_uuid : string

UUID of the node

Returns:

string list

migrate(self, instanceid, destination_node_uuid, wait=True)

Migrates the given instance

Returns:

string

offload(self, fdu_uuid)

Removes the given FDU from the system catalog Needs at least one node in the system!

Parameters:

fdu_uuid : string

UUID of fdu

Returns:

string

onboard(self, descriptor)

Registers an FDU descriptor in the system catalog Needs at least one node in the system!

Parameters:

descriptor : FDU

FDU descriptor

Returns:

FDU

pause(self, instanceid, wait=True)

Pauses the given instance

Returns:

string

resume(self, instanceid, wait=True)

Resumes the given instance

Returns:

string

search(self, search_dict, node_uuid=None)

Searches for flavors that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

node_uuid : string

optional node UUID where search

Returns:

string list

start(self, instanceid, wait=True)

Starts the given instance

Returns:

string

stop(self, instanceid, wait=True)

Stops the given instance

Returns:

string

terminate(self, instanceid, wait=True)

Terminates the given instance

This function calls: stop, clean, undefine

Returns:

string

undefine(self, instanceid)

Undefines the given instance

Returns:

string

Image

class fog05.fimapi.FIMAPI.Image(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: Image This class encapsulates API for Images

Methods

add(self, descriptor)	Registers an image in the system catalog Needs at least one not in the system
get(self, image_uuid)	Gets the information about the given image
list(self)	Gets all the images registered in the system catalog
remove(self, image_uuid)	Removes the given image from the system catalog Needs at least one not in the system
search(self, search_dict[, node_uuid])	Searches for images that satisfies the parameter

add(self, descriptor)

Registers an image in the system catalog Needs at least one not in the system

Parameters:

descriptor : dictionary

image descriptor

Returns:

string

get(self, image_uuid)

Gets the information about the given image

Parameters:

image_uuid : string

UUID of image

Returns:

dictionary

list(self)

Gets all the images registered in the system catalog

Returns:

string list

remove(self, image_uuid)

Removes the given image from the system catalog Needs at least one not in the system

Parameters:

image_uuid : string

Returns:

string

search(self, search_dict, node_uuid=None)

Searches for images that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

node_uuid : string

optional node UUID where search

Returns:

string list

Flavor

class fog05.fimapi.FIMAPI.Flavor(connector=None, sysid=<sphinx.ext.autodoc.importer._MockObject object>, tenantid=<sphinx.ext.autodoc.importer._MockObject object>)

Class: Flavor This class encapsulates API for Flavors

Methods

add(self, descriptor)	Registers a flavor in the system catalog Needs at least one node in the system
get(self, flavor_uuid)	Gets information about the given flavor
list(self)	Gets all the flavors registered in the system catalog
remove(self, flavor_uuid)	Removes the given flavor from the system catalog Needs at least one node in the system
search(self, search_dict[, node_uuid])	Searches for flavors that satisfies the parameter

add(self, descriptor)

Registers a flavor in the system catalog Needs at least one node in the system

Parameters:

descriptor : dictionary

flavor descriptor

Returns:

string

get(self, flavor_uuid)

Gets information about the given flavor

Parameters:

flavor_uuid : string

UUID of flavor

Returns:

dictionary

list(self)

Gets all the flavors registered in the system catalog

Returns:

string list

remove(self, flavor_uuid)

Removes the given flavor from the system catalog Needs at least one node in the system

Parameters:

flavor_uuid : string

UUID of flavor

Returns:

string

search(self, search_dict, node_uuid=None)

Searches for flavors that satisfies the parameter

Parameters:

search_dict : dictionary

search parameters

node_uuid : string

optional node UUID where search

Returns:

string list