/ 
Ovirt-0.06
River stage zero No dependents
/ Ovirt::Display

NAME

Ovirt::Display - Generate display config for remote viewer

VERSION

Version 0.01

SYNOPSIS

use Ovirt::Display;

my %con = (
           username                => 'admin',
           password                => 'password',
           manager                 => 'ovirt-mgr.example.com',
           id                      => 'e20cc93c-f526-4682-a250-924fa953f57b',
           expiry                  => 300,
);

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

Other attributes is also inherited from Ovirt.pm
Check 'perldoc Ovirt' for detail

notes :
ro                     = read only, can be specified only during initialization
rw                     = read write, user can set this attribute
rwp                    = read write protected, for internal class 

expiry                 = (rw) specify password expiry in seconds, default is 120s
ca                     = (rwp) store ca contents

SUBROUTINES/METHODS

BUILD

The Constructor, build logging, call pass_log_obj method from Ovirt.pm
get and set ca certificate

generate

$display->generate($expire, $vmid);
we can also set it during initialization (it's recommended to specify id for efficiency)
my %con = (
           username                => 'admin',
           password                => 'password',
           manager                 => 'ovirt-mgr.example.com',
           expiry                  => 300,
           id                      => 'e20cc93c-f526-4682-a250-924fa953f57b'
);

my $display = Ovirt::Display->new(%con);
$display->generate();

get_vnc_template

get_vnc_template($vmname,$password,$expiry,$display_address,$display_port);
internal method, will return vnc template for Remote Viewer

get_spice_template

get_spice_template($vmname,$password,$expiry,$display_address,$display_port,$display_host_subject);
internal method, will return spice template for Remote Viewer

set_ticket

set_ticket($expire, $vmid);
this method will set the password expiry and will return the password

get_display_info

get_display_info($vmid);

internal method to query vm display information.
this will croak if vm state is not up.
By default will return vmid,name,state,display_type,display_address,display_port,display_host_subject.
check Ovirt::VM for more information

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::Display>.  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::Display

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.