Chris Nehren > VirtualBox-Manage > VirtualBox::Machine

Download:
VirtualBox-Manage-0.0.0.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

VirtualBox::Machine -- a VirtualBox virtual machine.

VERSION ^

This documentation refers to VirtualBox::Machine version 0.0.0.

SYNOPSIS ^

    use VirtualBox::Manage;
    use Moose::Autobox;
    my $vb = VirtualBox::Manage->new($args);
    my $freebsd = $vb->machines->at('FreebSD');
    $freebsd->start;
    print $freebsd->running ? "It's running!" : "An error slipped past!";
    $freebsd->stop;
    print $freebsd->running ? "An error slipped past!" : "It's not running.";

DESCRIPTION ^

This class represents a VirtualBox virtual machine. It provides an API for programmatically managing VMs. This includes starting and stopping as well as a collection of accessors for various attributes of the VM.

ATTRIBUTES ^

config_file

Read-only attribute denoting the XML configuration file for this machine.

uuid

Read-only attribute specifying the UUID for this machine.

name

Read-only attribute specifying user-friendly name for this machine.

METHODS ^

running

Returns a Boolean describing whether the machine is presently running.

start

Attempts to start the machine. Dies on failure.

stop

Attempts to stop the machine. Dies on failure.

AUTHOR ^

Christopher Nehren <<< <apeiron@cpan.org> >>>

LICENSE AND COPYRIGHT ^

Copyright (c) 2008 Christopher Nehren (<<< <apeiron@cpan.org> >>>). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic and perlgpl.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

syntax highlighting: