Difference between revisions of "PluginsAPI"

From VNUML-WIKI
Jump to: navigation, search
Line 12: Line 12:
 
|-
 
|-
 
| createPlugin
 
| createPlugin
| mode ("t", "d", "x" or "P"), file (from <extension>) conf attribute
+
| ''mode'' ("t", "d", "x" or "P"), ''file'' (from <extension> conf attribute)
 
| Nothing (if plugin creation is ok) or error string (if error occurs during creation)
 
| Nothing (if plugin creation is ok) or error string (if error occurs during creation)
 
| Main objects creation at the beginning of VNUML operation
 
| Main objects creation at the beginning of VNUML operation
Line 18: Line 18:
 
|-
 
|-
 
| bootingCreateFiles
 
| bootingCreateFiles
| -
+
| <vm> name
| -
+
| Hash:
| -
+
* Key (string): the absolute pathname of the file to create in the VM filesystem
 +
* Value (string): the absolute pathname of the file in the host filesystem. The file would be removed after VNUML process it (so temporal files in /tmp are preferable)
 +
'''NOTE''': if the "ERROR" key exists, then VNUML interrupts execution, printing
 +
the value of "ERROR" key as output.
 +
| In &UML_bootfile, just after adding the /mnt/hostfs mountpoint.
 
| 1.9.0
 
| 1.9.0
 
|-
 
|-
 
| bootingCommands
 
| bootingCommands
| -
+
| <vm> name
| -
+
| A list of strings. The first element in the list is an empty string (if there was not any error during plugin operation) or a error string (which is printed by VNUML, interruption execution afterwards). All the remaining elements are the commands to execute in the virtual machine at booting time (in the same order).
| -
+
| In &UML_bootfile, just after bootingCreateFiles
 
| 1.9.0
 
| 1.9.0
 
|-
 
|-

Revision as of 21:04, 2 March 2009

VNUML Plugins API

The plugins API version 1.0 includes the following methods:

Method Name Arguments Return VNUML call point Since
createPlugin mode ("t", "d", "x" or "P"), file (from <extension> conf attribute) Nothing (if plugin creation is ok) or error string (if error occurs during creation) Main objects creation at the beginning of VNUML operation 1.9.0
bootingCreateFiles <vm> name Hash:
  • Key (string): the absolute pathname of the file to create in the VM filesystem
  • Value (string): the absolute pathname of the file in the host filesystem. The file would be removed after VNUML process it (so temporal files in /tmp are preferable)

NOTE: if the "ERROR" key exists, then VNUML interrupts execution, printing the value of "ERROR" key as output.

In &UML_bootfile, just after adding the /mnt/hostfs mountpoint. 1.9.0
bootingCommands <vm> name A list of strings. The first element in the list is an empty string (if there was not any error during plugin operation) or a error string (which is printed by VNUML, interruption execution afterwards). All the remaining elements are the commands to execute in the virtual machine at booting time (in the same order). In &UML_bootfile, just after bootingCreateFiles 1.9.0
execVmsToUse - - - 1.9.0
execCreateFiles - - - 1.9.0
execCommands - - - 1.9.0
finalizePlugin - - - 1.9.0