GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  REX::BOX::BASE (3)

.ds Aq ’

NAME

Rex::Box::Base - Rex/Boxes Base Module

CONTENTS

DESCRIPTION

This is a Rex/Boxes base module.

METHODS

These methods are shared across all other Rex::Box modules.

    info

Returns a hashRef of vm information.

    name($vmname)

Sets the name of the virtual machine.

    setup(@tasks)

Sets the tasks that should be executed as soon as the VM is available through SSH.

    storage(’path/to/vm/disk’)

Sets the disk path of the virtual machine. Works only on KVM

import_vm()

This method must be overwritten by the implementing class.

stop()

Stops the VM.

start()

Starts the VM.

ip()

Return the ip:port to which rex will connect to.

status()

Returns the status of a VM.

Valid return values are running and stopped.

    provision_vm([@tasks])

Executes the given tasks on the VM.

    cpus($count)

Set the amount of CPUs for the VM.

    memory($memory_size)

Sets the memory of a VM in megabyte.

    network(%option)

Configure the network for a VM.

Currently it supports 2 modes: nat and bridged. Currently it supports only one network card.



 $box->network(
   1 => {
     type => "nat",
   },
 }

 $box->network(
   1 => {
     type => "bridged",
     bridge => "eth0",
   },
 );



    forward_port(%option)

Set ports to be forwarded to the VM. This is not supported by all Box providers.



 $box->forward_port(
   name => [$from_host_port, $to_vm_port],
   name2 => [$from_host_port_2, $to_vm_port_2],
   ...
 );



    list_boxes

List all available boxes.

    url($url)

The URL where to download the Base VM Image. You can use self-made images or prebuild images from http://box.rexify.org/.

    auth(%option)

Configure the authentication to the VM.



 $box->auth(
   user => $user,
   password => $password,
   private_key => $private_key,
   public_key => $public_key,
 );



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 REX::BOX::BASE (3) 2016-03-07

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.