NAME
OpenVZ - Base class for OpenVZ utilities like vzctl
VERSION
This document describes v0.01 of OpenVZ - released April 17, 2012 as part of OpenVZ.
SYNOPSIS
use parent 'OpenVZ';
#XXX: need to add more examples
DESCRIPTION
This is a base class for OpenVZ utilities like vzctl and vzlist. It
shouldn't be used generally outside of this framework.
FUNCTIONS
new
If you prefer an object oriented interface then just "use
OpenVZ::submodule" and call the new function. All of the following
functions will be available as methods.
$vzctl = OpenVZ::vzctl->new;
$vzctl->set({ ctid => 101, name => 'user101', save => '' });
execute
This function should not be called directly unless you know what you're
doing.
"execute" uses IPC::Run3::Simple's "run3" function to make system calls.
"run3" returns whatever is sent to STDOUT, STDERR and the exit value as
well as the execution time of the system call.
This function is the workhorse of this package. It expects the following
parameters as a hashref
command => program name to be called (e.g., vzctl) (STRING)
params => parameters to be passed to the command to be called (ARRAYREF)
"params" is optional.
The params value will not be checked for validity. It is assumed that if
you are calling this subroutine you have already validated whatever is
going to be passed on the command line.
INSTALLATION
See perlmodinstall for information and options on installing Perl
modules.
AUTHOR
Alan Young <
[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Alan Young.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
