Difference between revisions of "PluginsAPI"
| Line 15: | Line 15: | ||
| 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 | ||
| − | | 1.9. | + | | 1.9.0beta1 |
|- | |- | ||
| bootingCreateFiles | | bootingCreateFiles | ||
| Line 25: | Line 25: | ||
the value of "ERROR" key as output. | the value of "ERROR" key as output. | ||
| In &UML_bootfile, just after adding the /mnt/hostfs mountpoint. | | In &UML_bootfile, just after adding the /mnt/hostfs mountpoint. | ||
| − | | 1.9. | + | | 1.9.0beta2 |
|- | |- | ||
| bootingCommands | | bootingCommands | ||
| Line 31: | Line 31: | ||
| 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). | | 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 | | In &UML_bootfile, just after bootingCreateFiles | ||
| − | | 1.9. | + | | 1.9.0beta2 |
|- | |- | ||
| execVmsToUse | | execVmsToUse | ||
| − | | | + | | command sequence |
| − | | | + | | List of VM names that take part in the sequence passed as argument |
| − | | | + | | In &get_vm_to_use within the DataHandler.pm module |
| − | | 1.9. | + | | 1.9.0beta3 |
|- | |- | ||
| execCreateFiles | | execCreateFiles | ||
Revision as of 22:07, 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.0beta1 |
| bootingCreateFiles | <vm> name | Hash:
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.0beta2 |
| 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.0beta2 |
| execVmsToUse | command sequence | List of VM names that take part in the sequence passed as argument | In &get_vm_to_use within the DataHandler.pm module | 1.9.0beta3 |
| execCreateFiles | - | - | - | 1.9.0 |
| execCommands | - | - | - | 1.9.0 |
| finalizePlugin | - | - | - | 1.9.0 |
