Changes between Version 77 and Version 78 of VboxApps


Ignore:
Timestamp:
Aug 13, 2014, 12:00:24 PM (10 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • VboxApps

    v77 v78  
    110110{{{
    111111<vbox_job>
     112   <memory_size_mb>N</memory_size_mb>
    112113   <os_name>name</os_name>
    113    <memory_size_mb>N</memory_size_mb>
    114    [ <vm_disk_controller_type>ide|sata|scsi|floppy|sas</vm_disk_controller_type> ]
    115    [ <vm_disk_controller_model>LSILogic|LSILogicSAS|BusLogic|IntelAHCI|PIIX3|PIIX4|ICH6|I82078</vm_disk_controller_model> ]
     114   [ <completion_trigger_file>filename</completion_trigger_file> ]
     115   [ <copy_to_shared>filename</copy_to_shared> ]
     116   [ <enable_floppyio>0|1</enable_floppyio> ]
    116117   [ <enable_network/> ]
     118   [ <enable_remotedesktop>0|1</enable_remotedesktop> ]
    117119   [ <enable_shared_directory/> ]
    118    [ <enable_floppyio>0|1</enable_floppyio> ]
    119    [ <enable_remotedesktop>0|1</enable_remotedesktop> ]
     120   [ <fraction_done_filename>filename</fraction_done_filename> ]
    120121   [ <job_duration>X</job_duration> ]
    121    [ <fraction_done_filename>filename</fraction_done_filename> ]
     122   [ <minimum_checkpoint_interval>N</minimum_checkpoint_interval> ]
    122123   [ <pf_guest_port>N</pf_guest_port> ]
    123124   [ <pf_host_port>N</pf_host_port> ]
    124    [ <copy_to_shared>filename</copy_to_shared> ]
    125    [ <trickle_trigger_file>filename</trickle_trigger_file> ]
    126    [ <completion_trigger_file>filename</completion_trigger_file> ]
    127    [ <minimum_checkpoint_interval>N</minimum_checkpoint_interval> ]
    128125   [ <port_forward>
    129126        <host_port>H</host_port>
    … …  
    131128        [<is_remote>0|1</is_remote>]
    132129        [<nports>N</nports]
     130   [ <trickle_trigger_file>filename</trickle_trigger_file> ]
     131   [ <vm_disk_controller_model>LSILogic|LSILogicSAS|BusLogic|IntelAHCI|PIIX3|PIIX4|ICH6|I82078</vm_disk_controller_model> ]
     132   [ <vm_disk_controller_type>ide|sata|scsi|floppy|sas</vm_disk_controller_type> ]
    133133   }
    134134</vbox_job>
    135135}}}
    136 The elements are:
    137 
     136Required elements:
     137
     138 '''memory_size_mb''':: the amount of physical memory allocated to the VM, in megabytes.
    138139 '''os_name''':: the name of the guest OS as defined by !VirtualBox,
    139140   e.g. "Linux26", "Linux26_64", "Linux24", etc.
    140141   To see a list of all available OS names, install !VirtualBox on a system,
    141142   and type "vboxmanage list ostypes".
    142  '''memory_size_mb''':: the amount of physical memory allocated to the VM, in megabytes.
    143  '''vm_disk_controller_type''':: which disk controller type to emulate.
    144  '''vm_disk_controller_model''':: which disk controller model to emulate.
    145  '''enable_network''':: if present, allow the VM to do network access.
    146  '''enable_shared_directory''':: if present, create a directory that is shared
    147    between the host OS and the guest OS.
    148    Must be set if your application has input or output files.
    149  '''enable_floppyio''':: create a floppy disk image in the VM,
    150   containing the contents of init_data.xml.
    151  '''enable_remotedesktop''':: If the Oracle VirtualBox Extension are installed, it'll enable
    152   the use of a remote desktop client to view the console of the VM.
    153  '''job_duration''':: this specifies the maximum elapsed time of the job,
    154   after which vboxwrapper will kill the VM and exit normally.
    155  '''fraction_done_filename''':: the name of a file to which the app will
    156   periodically write its fraction done (0 to 1).
    157   This is used by the wrapper to report overall fraction done.
    158  '''pf_guest_port''':: enable port forwarding to port N within the VM.
    159   This is assumed to be a web server providing application graphics.
    160  '''copy_to_shared''':: copy the given file from the slot directory the shared directory before launch.
    161   For example, you can use to copy '''init_data.xml''' into the VM.
    162   This directive can be used more than once.
    163  '''trickle_trigger_file''':: provides a mechanism for the VM to send trickle-up messages.
    164    If a file of the given name appears in the shared directory,
    165    vboxwrapper sends a [TrickleApi trickle-up message] whose variety is the filename
    166    and whose contents is the contents of the file, then deletes the file.
     143
     144 Optional elements:
    167145 '''completion_trigger_file'''::
    168146   This provides a more bulletproof way for VM apps to exit;
    … …  
    173151   If vboxwrapper finds this file,
    174152   it cleans up the VM and exits with the given code (default 0).
     153 '''copy_to_shared''':: copy the given file from the slot directory the shared directory before launch.
     154  For example, you can use to copy '''init_data.xml''' into the VM.
     155  This directive can be used more than once.
     156 '''enable_floppyio''':: create a floppy disk image in the VM,
     157  containing the contents of init_data.xml.
     158 '''enable_network''':: if present, allow the VM to do network access.
     159 '''enable_remotedesktop''':: If the Oracle VirtualBox Extension are installed, it'll enable
     160  the use of a remote desktop client to view the console of the VM.
     161 '''enable_shared_directory''':: if present, create a directory that is shared
     162   between the host OS and the guest OS.
     163   Must be set if your application has input or output files.
     164 '''fraction_done_filename''':: the name of a file to which the app will
     165  periodically write its fraction done (0 to 1).
     166  This is used by the wrapper to report overall fraction done.
     167 '''job_duration''':: this specifies the maximum elapsed time of the job,
     168  after which vboxwrapper will kill the VM and exit normally.
    175169 '''minimum_checkpoint_interval''':: minimum number of seconds before a checkpoint/snaposhot can be created.
    176170  Defaults to 10 minutes. (v26086+)
     171 '''pf_guest_port''':: enable port forwarding to port N within the VM.
     172  This is assumed to be a web server providing application graphics.
    177173 '''port_forward''':: defines a port forwarding between the given host and guest ports.
    178174    If '''nports''' is specified, N ports will be forwarded:
    … …  
    181177    otherwise they can be accessed only from processes on this computer.
    182178   There may be more than one of these elements.
     179 '''trickle_trigger_file''':: provides a mechanism for the VM to send trickle-up messages.
     180   If a file of the given name appears in the shared directory,
     181   vboxwrapper sends a [TrickleApi trickle-up message] whose variety is the filename
     182   and whose contents is the contents of the file, then deletes the file.
     183 '''vm_disk_controller_model''':: which disk controller model to emulate.
     184 '''vm_disk_controller_type''':: which disk controller type to emulate.
    183185
    184186== Vboxwrapper command-line options ==
    … …  
    546548vboxmanage modifyhd FILENAME.vdi --compact
    547549}}}
    548