View source for Virtualbox Command Line Utility

The following [[:category:bash|Bash]] script was created to make controlling [http://virtualbox.org Virtualbox] from the command line a little easier.

This script was created while using Virtualbox 3.1.6<br />
Tested on:
* Virtualbox 3.1.6


{{toc}}

== Configure ==

The script itself has one config setting: <b>'viewYNinMenu'</b><br />
After any/all option menus are displayed, you can have a second question asked: <code>"You choose '$this' (y/n)?"</code><br />
Setting <b>'viewYNinMenu'</b> to 1 will enable this second question, setting <b>'viewYNinMenu'</b> to 0 the second question will not be asked.


== Main Menu Options ==
[[File:Vbox utily mainmenu.jpg]]

=== Create New vm Guest ===
Function called <code>createNewVM()</code>

You will be asked a few questions
* New guest name
* Menu: What OS (choices from <code>VBoxManage list ostypes</code>)
[[File:Vbox utily select os.jpg]]
* Path to .iso
* Memory Size
* Harddrive Size
* .vdi file name (or file name and path if you want to store the .vdi file else where) Default: ~/.VirtualBox/HardDisks/
* The variables at the top of the <code>createNewVM()</code> functon will be used for the rest of the options <br />boot1, boot2, clipboard, acpi, ioapic, pae, nestedpaging, cpus, synthcpu, hwvirtex, vtxvpid, snapshotfolder, vram, accelerate3d, accelerate2dvideo, vrdp, vrdpport, vrdpauthtype, vrdpmulticon, storagectl, storagect2, floppy, usb, usbehci, audio, audiocontroller, nic1, nictype1, cableconnected1

After the questions are asked, the script will display your answers with a final prompt to create. Then you will be asked if you want to Start the guest (in "Headless" mode) <code>VBoxHeadless -startvm [name]</code> 


=== DELETE Guest ===
............


=== Power Management ===
Uses <code>selectPowerManagement()</code><br />

Questions asked:
* Menu: What guest to work with
* Menu: Power Options
[[File:Vbox_utily_powermangmant.jpg]]<br />


=== Add DVD iso ===
..............


=== Add shared folder ===
Calls <code>workWithShareFolders()</code><br />
Lets you add a new Shared Folder to a guest.<br />

Questions asked:
* Menu: What guest to work with
* Host path to Shared folder
* Share folder name
* readonly
* transient
* Then the final "do you want to do this (y/n)"


New shared folders can only be added to guests which are not running.<br />
If the guest is running you will be prompted:<br />
[[File:Vbox_utily_sharedfolder.jpg]]



=== Add storage (harddrive) ===
...........



===  Remove DVD iso ===
...............


=== Remove shared folder ===
Calls <code>workWithShareFolders()</code><br />
Lets you remove a Shared Folder from a guest.<br />

Questions asked:
* Menu: What guest to work with
* Menu: Listing the names of the current shared folders
* transient
* Then the final "do you want to do this (y/n)"

Just like adding a new Shared Folder, guest must be off.



=== Remove storage (harddrive) ===
...........


=== Select Guest and showvminfo ===
Calls <code>askWhatVM_thenDisplayInfo()</code>
<source lang="bash">askWhatVM_thenDisplayInfo "Select guest to view" 1</source>


=== Display "VBoxManage list" options ===
Displays menu for <code>VBoxManage list</code><br />
This can be edited in the <code>displayVBoxManageList()</code><br />
[[File:Vbox utily vboxmanage list.jpg]]


=== Command line ===
Lets you work with the terminal command line with-out exiting the script


== Functions ==

=== startUpQuestions() ===


=== askWhatVM_thenDisplayInfo() ===
This function will:
# Create a Menu parsing <code>VBoxManage list vms</code> out-put and displaying the names of the Guests installed on the host.<br />
[[File:VboxUtily select guest.jpg]]
# "Returns" some information
# Display <code>VBoxManage showvminfo [vmaname]</code> if argument is passed


Arguments passed into function:
* Question (string)<br />This function can be called for different reasons so we pass the "question" to it
* Display <code>VBoxManage showvminfo [vmaname]</code> (int)<br />Thought an option to display the Guest info would be nice.


Returns an "Array"
* arr[0] = Name
* arr[1] = UUID
* arr[2] = 1st Controller
* arr[3] = 2nd Controller
* arr[4] = Shared folders
* arr[5] = State (running, saved, off, etc.)

Usage:
<source lang="bash">
# mock-up
# Just ask question and get results with out displaying 'VBoxManage showvminfo'
tmpArr=( $(askWhatVM_thenDisplayInfo "Add iso to DVD for ?") )
vmGuestName="${tmpArr[0]}"
vmGuestUUID="${tmpArr[1]}"
......
......
VBoxManage storageattach "$vmGuestUUID"....
</source>
OR
<source lang="bash">
# Display info from 'VBoxManage showvminfo'
askWhatVM_thenDisplayInfo "Display info for guest ?" 1 ;
</source>


=== displayVBoxManageList() ===


=== workWithShareFolders() ===
This function will first display a menu to choose what guest to work with via the <code>askWhatVM_thenDisplayInfo()</code> function. After it gets the results from askWhatVM_thenDisplayInfo it will do a check to see what 'state' the guest is in, if guest is not in the 'powered off' state, another menu will appear where you can turn off the guest with one of the <code>VBoxManage controlvm</code> options (''pause|resume|reset|poweroff|savestate|acpipowerbutton|acpisleepbutton''). 

After machine is turned off a list of current shared folders will be displayed and depending on why you are calling this function (adding a new Share or removing a Share) you will be asked acouple questions.

Adding Shared Folder:
* Host path to Shared folder
* Share folder name
* readonly
* transient
* Then the final "do you want to do this (y/n)"

Removing Shared Folder:
* A menu will appear listing the names of the current shared folders
* transient
* Then the final "do you want to do this (y/n)"

If you select "no" to the "do you want to do this (y/n)" questions, you will be brought back to the main menu.


Arguments passed into function:
* "todo" (string) - adding or removing


=== workWithDVD() ===
Calls <code> </code>

Arguments passed into function:
* "Question" (string)
* "todo" (string)


=== createNewVM() ===
At the top of this function you ca set a bunch of variables which will be used during the creation of a new vm guest.



=== choose_OSfromList() ===


=== askQuestion() ===


=== displayOptions() ===


=== selectPowerManagement() ===
Calls <code>askWhatVM_thenDisplayInfo()</code> and <code>powerOffSaveState()</code><br />


=== powerOffSaveState() ===
Calls <code>displayOptions()</code> and <code>loopPowerState()</code><br />


=== loopPowerState() ===
Arguments passed into function:
* vmID (string)
* stateOrg (string)

When this function is called it will loop <code>VBoxManage showvminfo [vmID]</code>, grab the current 'state' of the guest and compare that to the passed 'stateOrg'. When the current state is different then the passed 'stateOrg' it will break the loop.

This is used mainly for shutting down a machine with <code>VBoxManage controlvm [name] acpipowerbutton</code> during changes to a guest which require the guest to be turned off. Since it takes alittle while for a guest to shut down, this loop let you know when the guest is off.





== Thanks to ==
'''[http://ubuntuforums.org/member.php?u=243323 geirha]'''<br />
Roughly a year ago i made the switch to Ubuntu (from Windows). Through that time I've been learning Bash when time permits and for this "project", geirha has been a great help and has taught me so much. Thank you.


== The script ==
{{:Virtualbox_Command_Line_Utility/1.0.0}}


[[Category:VirtualBox]]