/ 
Ovirt-0.02
River stage zero No dependents
/ Ovirt::Cluster

NAME

Ovirt::Cluster - Bindings for Ovirt Cluster API

VERSION

Version 0.01

SYNOPSIS

use Ovirt::Cluster;

my %con = (
           username                => 'admin',
           password                => 'password',
           manager                 => 'ovirt-mgr.example.com',
           cluster_output_attrs    => 'id,name,cpu_id,cpu_arch,description', # optional 
);

my $cluster = Ovirt::Cluster->new(%con);

# return xml output
print $cluster->list_xml; 

# list cluster attributes
print $cluster->list;

# the output also available in hash
# for example to print all cluster name
my $hash = $cluster->hash_output;
for my $array (keys $hash->{cluster}) {
   print $hash->{cluster}[$array]->{name};
}

# we can also specify specific cluster 'id' when initiating an object
# so we can direct access the element for specific cluster
print $cluster->hash_output->{name};                   
print $cluster->hash_output->{cluster}->{id};

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 

cluster_url            = (ro) store default cluster url path
cluster_output_attrs   = (rw) store cluster attributes to be returned, default is (id, name, description)
                         supported attributes :
                           id          name    
                           cpu_id      description
                           cpu_arch    datacenter_id
                           ver_major   ver_minor
                           sched_name  sched_policy
                           
cluster_output_delimiter    = (rw) specify output delimiter between attribute, default is '||'

SUBROUTINES/METHODS

BUILD

The Constructor, build logging, call pass_log_obj method
Built root_url with cluster_url
set output with get_api_response method from Ovirt.pm

list_xml

return xml output

list

return cluster's attributes text output from hash_output attribute
if no argument spesified, it will return all cluster attributes (based on cluster_output_attrs)
argument supported is 'cluster id'
example :
$cluster->list('c4738b0f-b73d-4a66-baa8-2ba465d63132');

get_cluster_by_element_id

This method is used by list method to list all cluster attributes requested
An array element id and attribute name is required

get_cluster_by_self_id

This method is used by list method if $self->id is defined
The id is set during initialization (id => 'clusterid')
attribute name is required

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

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.