From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Ovirt-0.06
River stage zero No dependents
/ Ovirt

NAME

Ovirt - Bindings for oVirt REST API

VERSION

Version 0.06

SYNOPSIS


            

              
              
use Ovirt::VM;
use Ovirt::Template;
use Ovirt::Cluster;
use Ovirt::Host;
use Ovirt::Display;
my %con = (
           username                => 'admin',
           password                => 'password',
           manager                 => 'ovirt-mgr.example.com',
           api_output              => 'xml', # optional, default to json
           vm_output_attrs         => 'id,name,state,description', # optional
           cluster_output_attrs    => 'id,name,cpu_id,cpu_arch,description', # optional
);
my $vm         = Ovirt::VM         ->new(%con);
my $cluster    = Ovirt::Cluster    ->new(%con);
my $template   = Ovirt::Template   ->new(%con);
my $host       = Ovirt::Host       ->new(%con);
# return xml output / json
print $vm->list_xml;   
print $vm->list_json;                           
# list attributes based on 'vm_output_attrs'
print $vm      ->list;
print $cluster ->list;
print $template->list;
print $host    ->list;
# create, remove vm
$vm->create('vm1','Default','CentOS7');
$vm->remove('2d83bb51-9a77-432d-939c-35be207017b9');
# add/remove/list vm's nic and disk
$vm->add_disk('6efc0cfa-8495-4a96-93e5-ee490328cf48',  # vm id
               'virtio',                               # driver interface
               'cow',                                  # format
               '1073741824',                           # size
               'mydisk1',                              # disk name
               '9b952bdc-b7ec-4673-84b0-477b48945a9a'  # storage domain id
             );
$vm->add_nic('6efc0cfa-8495-4a96-93e5-ee490328cf48',   # vm id
             'virtio',                                 # driver interface
             'nic1',                                   # nic name
             'rhevm'                                   # network name
            );
# start, stop, reboot, migrate vm
$vm->start     ('b4738b0f-b73d-4a66-baa8-2ba465d63132');
$vm->stop      ('b4738b0f-b73d-4a66-baa8-2ba465d63132');
$vm->reboot    ('b4738b0f-b73d-4a66-baa8-2ba465d63132');
$vm->migrate   ('b4738b0f-b73d-4a66-baa8-2ba465d63132');
# the output also available in hash
# for example to print all vm name and state
my $hash = $vm->hash_output;
for my $array (keys $hash->{vm}) {
   print $hash->{vm}[$array]->{name} . " " . 
       $hash->{vm}[$array]->{status}->{state};
}
# we can also specify specific vm 'id' when initiating an object
# so we can direct access the element for specific vm
print $vm->hash_output->{name};                   
print $vm->hash_output->{cluster}->{id};
# Generate display configuration for remote viewer
my $display = Ovirt::Display->new(%con);
print $display->generate();
sample spice configuration output :
[virt-viewer]
   type=spice
   host=192.168.1.152
   port=-1
   password=+cnsq458Oq6T
   # Password is valid for 300 seconds.
   tls-port=5902
   fullscreen=0
   title=C1 : %d - Press SHIFT+F12 to Release Cursor
   enable-smartcard=0
   enable-usb-autoshare=1
   delete-this-file=1
   usb-filter=-1,-1,-1,-1,0
   tls-ciphers=DEFAULT
   host-subject=O=example.com,CN=192.168.1.152
   ca=-----BEGIN CERTIFICATE-----\n -- output removed -- S2fE=\n-----END CERTIFICATE-----\n
   toggle-fullscreen=shift+f11
   release-cursor=shift+f12
   secure-attention=ctrl+alt+end
   secure-channels=main;inputs;cursor;playback;record;display;usbredir;smartcard
you can save it to a file then use remote viewer to open it:
$ remote-viewer [your saved file].vv

Attributes


            

              
              
notes :
ro             = read only, can be specified during initialization
rw             = read write, user can set this attribute
rwp            = read write protected, for internal class
username       = (ro, required) store Ovirt username
password       = (ro, required) store Ovirt password
manager        = (ro, required) store Ovirt Manager address
port           = (ro) store Ovirt Manager's port (must be number)
id             = (ro) store object id, if it's provided during initialization,
                  the rest api output will only contain attributes for this id
domain         = (ro) store Ovirt Domain (default domain : internal)
ssl            = (ro) if yes, use https (default is yes)
ssl_verify     = (ro) disable host verification (default is no)
log_severity   = (ro) store log severity level, valid value ERROR|OFF|FATAL|INFO|DEBUG|TRACE|ALL|WARN
                 (default is INFO)
api_output     = (ro) json/xml, default is json
not_available  = (rw) store undef or empty output string, default to 'N/A'
url            = (rwp) store final url to be requested to Ovirt
root_url       = (rwp) store url on each object
log            = (rwp) store log from log4perl
xml_output     = (rwp) store xml output from API output
json_output    = (rwp) store json output from API output
hash_output    = (rwp) store hash output converted from xml output

SUBROUTINES/METHODS


            

              
              
You may want to check :
- perldoc Ovirt::VM
- perldoc Ovirt::Template
- perldoc Ovirt::Cluster
- perldoc Ovirt::Host
- perldoc Ovirt::Display
- perldoc Ovirt::DataCenter
- perldoc Ovirt::Storage
- perldoc Ovirt::Network

BUILD


            

              
              
The Constructor, build logging, call pass_log_obj method

pass_log_obj


            

              
              
it will build the log which stored to $self->log
you can assign the severity level by assigning the log_severity 
# output to console / screen
# format : 
# %d = current date with yyyy/MM/dd hh:mm:ss format                       
# %p = Log Severity                                                       
# %P = pid of the current process                                         
# %L = Line number within the file where the log statement was issued       
# %M = Method or function where the logging request was issued            
# %m = The message to be logged                                           
# %n = Newline (OS-independent)

base_url


            

              
              
return the base url

api_url


            

              
              
build the final url

get_api_response


            

              
              
get xml response, store to xml_output.
the xml output is also converted to hash and stored
at hash_output attribute.
xml2hash somehow complaining the xml declaration, so we 
need to skip it and use 'toString' method on the xml string
parameter.

set_lwp_error


            

              
              
handle lwp if not success
required args ($tx)

get_api_output


            

              
              
handle and return output based on $self->api_output

get_json_response


            

              
              
handle http get for json output
required argument ('url')

get_xml_response


            

              
              
handle http get for xml output
required argument ('url')

list_xml


            

              
              
return xml output

list_json


            

              
              
return json output

trim


            

              
              
trim function to remove whitespace from the start and end of the string

ltrim


            

              
              
Left trim function to remove leading whitespace

rtrim


            

              
              
Right trim function to remove leading whitespace

AUTHOR


            

              
              
"Heince Kurniawan", C<< <"heince at cpan.org"> >>

BUGS


            

              
              
Please report any bugs or feature requests to C<bug-ovirt at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Ovirt>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

SUPPORT


            

              
              
You can find documentation for this module with the perldoc command.
   perldoc Ovirt
You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 "Heince Kurniawan".

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.