File Coverage

blib/lib/IBM/V7000.pm

Criterion	Covered	Total	%
statement	18	31	58.0
branch			n/a
condition			n/a
subroutine	6	11	54.5
pod	1	1	100.0
total	25	43	58.1

package IBM::V7000;

use strict;
use warnings;

use IBM::StorageSystem;
use Carp qw(croak);

our $VERSION = '0.02';

our @METHODS=qw(array drive enclosure host iogroup vdisk);

our @ATTRS = qw(auth_service_cert_set auth_service_configured auth_service_enabled
auth_service_pwd_set auth_service_type auth_service_url auth_service_user_name
bandwidth cluster_isns_IP_address cluster_locale cluster_ntp_IP_address code_level
console_IP email_contact email_contact2 email_contact2_alternate email_contact2_primary
email_contact_alternate email_contact_location email_contact_primary email_reply
email_state gm_inter_cluster_delay_simulation gm_intra_cluster_delay_simulation
gm_link_tolerance gm_max_host_delay has_nas_key id id_alias inventory_mail_interval
iscsi_auth_method iscsi_chap_secret layer location name partnership rc_buffer_size
relationship_bandwidth_limit space_allocated_to_vdisks space_in_mdisk_grps
statistics_frequency statistics_status stats_threshold tier tier_capacity tier_free_capacity
time_zone total_allocated_extent_capacity total_free_space total_mdisk_capacity
total_overallocation total_used_capacity total_vdisk_capacity total_vdiskcopy_capacity
compression_cpu_pc cpu_pc drive_r_io drive_r_mb drive_r_ms drive_w_io
drive_w_mb drive_w_ms fc_io fc_mb iscsi_io iscsi_mb mdisk_r_io mdisk_r_mb mdisk_r_ms
mdisk_w_io mdisk_w_mb mdisk_w_ms sas_io sas_mb total_cache_pc vdisk_r_io vdisk_r_mb
vdisk_r_ms vdisk_w_io vdisk_w_mb vdisk_w_ms write_cache_pc);
# TO DO: mdsik

foreach my $method ( @METHODS ) {
	{
		no strict 'refs';
		my $get_method	= "get_$method";
		my $get_methods	= "get_${method}s";

		*{ __PACKAGE__ ."::$method" } = sub {
			my $self = shift;
			$self->{ss}->$method(@_)
		};

		*{ __PACKAGE__ ."::$get_method" } = sub {
			my $self = shift;
			$self->{ss}->$get_method(@_)
		};

		*{ __PACKAGE__ ."::$get_methods" } = sub {
			my $self = shift;
			$self->{ss}->$get_methods(@_)
		}
	}
}

foreach my $attr ( @ATTRS ) {
	{
		no strict 'refs';

		*{ __PACKAGE__ ."::$attr" } = sub {
			my $self = shift;
			$self->{ss}->$attr(@_)
		};
	}
}

sub new {
        my ($class, %args) = @_;
        my $self = bless {} , $class;
        my %opts = ( user => $self->{user}, key_path => $self->{key_path}, batch_mode => 1, master_opts => '-q', );

        $self->{ss} = IBM::StorageSystem->new( %args );

        return $self
}

=head1 NAME

IBM::V7000 - Perl API to IBM V7000 CLI

=head1 VERSION

Version 0.01

=head1 SYNOPSIS

IBM::V7000 is a Perl API to IBM V7000 CLI.

=head1 METHODS

=head3 new

        my $ibm = IBM::V7000->new(      user            => 'admin',
                                        host            => 'my-v7000.company.com',
                                        key_path        => '/path/to/my/.ssh/private_key'
                        ) or die "Couldn't create object! $!\n";

Constructor - creates a new IBM::V7000 object.  This method accepts three mandatory parameters
and one optional parameter, the three mandatory parameters are:

=over 3

=item user

The username of the user with which to connect to the device.

=item host

The hostname or IP address of the device to which we are connecting.

=item key_path

Either a relative or fully qualified path to the private ssh key valid for the
user name and device to which we are connecting.  Please note that the executing user
must have read permission to this key.

=back

The optional parameter is:

=over 3

=item stats_threshold

The period in seconds for which retrieved system statistics will be considered fresh,
after which they will be re-retrieved.  If not set, the default value of this parameter
is zero meaning that the statistics are not refreshed unless done explicitly via the
B method of an L object.

=back

=head3 auth_service_cert_set

Specifies if the authentication service certificate has been set.

=head3 auth_service_configured

True if the auth_service_type is configured and either one of the following is true:

=over 3

=item * The auth_service_type is LDAP-only (if at least one LDAP server is configured)

=item * The auth_service_type is TIP-only:

=over 5

=item * The name, password, and URL are established

=item * An SSL certificate is created (if an HTTPS URL is available)

=back

=back

=head3 auth_service_enabled

True if auth_service_type is configured.

=head3 auth_service_pwd_set

Specifies if the authentication password has been set.

=head3 auth_service_type

returns the authentication services type, either; Tivoli Integrated Portal (TIP) or Native Lightweight
Directory Access Protocol (LDAP)

=head3 auth_service_url

Returns the authentication services URL.

=head3 auth_service_user_name

Returns the user name used for authentication services.

=head3 bandwidth

Returns the bandwidth available on the intersystem link for background copy, in megabytes per second (MBps).

=head3 cluster_isns_IP_address

Returns the cluster ISNS IP address.

=head3 cluster_locale

Returns the cluster configured locale.

=head3 cluster_ntp_IP_address

Returns the cluster NTP service address.

=head3 code_level

Returns the cluster code level.

=head3 console_IP

Returns the cluster console IP address.

=head3 email_contact

Returns the clusters email contact information - this value is usually the system name.

=head3 email_contact2

Returns the clusters extended email contact information.

=head3 email_contact2_alternate

Returns the clusters extended alternate email contact information.

=head3 email_contact2_primary

Returns the clusters extended primary email contact information.

=head3 email_contact_alternate

Returns the clusters email contact alternate information.

=head3 email_contact_location

Returns the clusters email contact location.

=head3 email_contact_primary

Returns the clusters email contact phone number.

=head3 email_reply

Returns the clusters email reply email.

=head3 email_state

Returns the clusters email operational state.

=head3 gm_inter_cluster_delay_simulation

Returns the cluster gm inter cluster delay simulation.

=head3 gm_intra_cluster_delay_simulation

Returns the cluster gm intra cluster delay simulation.

=head3 gm_link_tolerance

Returns the cluster gm link delay tolerance in seconds.

=head3 gm_max_host_delay

Returns the cluster gm maximum host delay value.

=head3 has_nas_key

Specifies if the cluster has a NAS key configured.

=head3 id

Returns the cluster ID.

=head3 id_alias

Returns the cluster ID alias.

=head3 inventory_mail_interval

Returns the cluster inventory mail interval period in days.

=head3 iscsi_auth_method

Returns the cluster iSCSI authentication method.

=head3 iscsi_chap_secret

Returns the iSCSI CHAP secret.

=head3 layer

Returns the cluster layer type; either replication or storage (default).
Replication means the system can create partnerships with Storwize StorageSystem Unified.
Storage means the system can present storage to Storwize StorageSystem Unified.

=head3 location

Returns the cluster location type, either local or remote.

=head3 name

Returns the cluster name.

=head3 partnership

Returns the cluster partnership type, either one of; fully_configured, partially_configured_local,
partially_configured_local_stopped, not_present, fully_configured_stopped, fully_configured_remote_stopped,
fully_configured_local_excluded, fully_configured_remote_excluded or fully_configured_exceeded

=head3 rc_buffer_size

Returns the cluster resource buffer size assigned for Metro Mirror or Global Mirrored Copy Services.

=head3 relationship_bandwidth_limit

Returns the cluster relationship bandwidth limit in megabytes per second (MBps).

=head3 space_allocated_to_vdisks

Returns the space allocated to VDisks - this may be in a variable notation format.

=head3 space_in_mdisk_grps

Returns the space allocated to MDisk groups - this may be in a variable notation format.

=head3 statistics_frequency

Returns the statistics collection frequency interval.

=head3 statistics_status

Returns the statistics collection status.

=head3 tier

Returns an array containing the supported tier types for the cluster.

B that this method returns an array of the available tier types and that the ordering
of these types is preserved from the CLI output.  The ordering of these types can be used to
retrieve the tier capacity of each tier type with the B command.

=head3 tier_capacity

Returns the total tier capacity for each tier type in the cluster.

B that this method returns an array of tier capacity ivalues, the index of
which corresponds with the array indexes of tier types as returned by the B method.

For example, to print each tier type and the corresponding tier capacity for this cluster:

        for ( my $i = 0; $i < scalar @{ $ibm->tier } ; $i++ ) {
                print "Tier: " . $ibm->tier->[$i] .
                        " - Capacity: " . $ibm->tier_capacity->[$i] . "\n"
        }

=head3 tier_free_capacity

Returns the free tier capacity for each tier type in the cluster.

B that like the B and B methods, this method also returns an
array of tier free capacity values, the order of which corresponds with the arrays returned
by the aforementioned methods.

=head3 time_zone

Returns the cluster time zone.

=head3 total_allocated_extent_capacity

Returns the clusters total allocated capacity - this may be in a variable notation format.

=head3 total_free_space

Returns the clusters total free space - this may be in a variable notation format.

=head3 total_mdisk_capacity

Returns the clusters total MDisk capacity - this may be in a variable notation format.

=head3 total_overallocation

Returns the cluster total overallocation limit.

=head3 total_used_capacity

Returns the clusters total used capacity - this may be in a variable notation format.

=head3 total_vdisk_capacity

Returns the clusters total VDisk capacity - this may be in a variable notation format.

=head3 total_vdiskcopy_capacity

Returns the clusters total VDisk copy capacity - this may be in a variable notation format.

=head3 compression_cpu_pc

Returns an L object for allocated CPU capacity utilised for compression.

=head3 cpu_pc

Returns an L object for allocated CPU capacity utilised for the system.

=head3 drive_r_io

Returns an L object the average amount of I/O operations transferred
per second for read operations to drives during the sample period.

=head3 drive_r_mb

Returns an L object for the average number of megabytes transferred
per second for read operations to drives during the sample period.

=head3 drive_r_ms

Returns an L object for the average amount of time in milliseconds
that the system takes to respond to read requests to drives over the sample period.

=head3 drive_w_io

Returns an L object the average amount of I/O operations transferred
per second for write operations to drives during the sample period.

=head3 drive_w_mb

Returns an L object for the average number of megabytes transferred
per second for write operations to drives during the sample period.

=head3 drive_w_ms

Returns an L object for the average amount of time in milliseconds
that the system takes to respond to write requests to drives over the sample period.

=head3 fc_io

Returns an L object for the total input/output (I/O) operations
transferred per seconds for Fibre Channel traffic on the system. This value includes
host I/O and any bandwidth that is used for communication within the system.

=head3 fc_mb

Returns an L object for the total number of megabytes transferred
per second for Fibre Channel traffic on the system. This value includes host I/O and any
bandwidth that is used for communication within the system.

=head3 iscsi_io

Returns an L object for the total I/O operations transferred
per second for iSCSI traffic on the system.

=head3 iscsi_mb

Returns an L object for the total number of megabytes
transferred per second for iSCSI traffic on the system.

=head3 mdisk_r_io

Returns an L object for the average amount of I/O operations
transferred per second for read operations to MDisks during the sample period.

=head3 mdisk_r_mb

Returns an L object for the average number of megabytes transferred
per second for read operations to MDisks during the sample period.

=head3 mdisk_r_ms

Returns an L object for the average amount of time in milliseconds
that the system takes to respond to read requests to MDisks over the sample period.

=head3 mdisk_w_io

Returns an L object for the average amount of I/O operations
transferred per second for write operations to MDisks during the sample period.

=head3 mdisk_w_mb

Returns an L object for the average number of megabytes transferred
per second for write operations to MDisks during the sample period.

=head3 mdisk_w_ms

Returns an L object for the average amount of time in milliseconds
that the system takes to respond to write requests to MDisks over the sample period.

=head3 sas_io

Returns an L object for the total I/O operations transferred per
second for SAS traffic on the system. This value includes host I/O and bandwidth that
is used for background RAID activity.

=head3 sas_mb

Returns an L object for the total number of megabytes
transferred per second for iSCSI traffic on the system.

=head3 total_cache_pc

Returns an L object for the total percentage for both the
write and read cache usage for the node.

=head3 vdisk_r_io

Returns an L object for the average amount of I/O operations
transferred per second for read operations to volumes during the sample period.

=head3 vdisk_r_mb

Returns an L object for the average number of megabytes
transferred per second for read operations to MDisks during the sample period.

=head3 vdisk_r_ms

Returns an L object for the average amount of time in
milliseconds that the system takes to respond to read requests to MDisks over the
sample period.

=head3 vdisk_w_io

Returns an L object for the average amount of I/O operations
transferred per second for read operations to drives during the sample period.

=head3 vdisk_w_mb

Returns an L object for the average number of megabytes transferred
per second for read operations to drives during the sample period

=head3 vdisk_w_ms

Returns an L object for the average amount of time in milliseconds
that the system takes to respond to read requests to MDisks over the sample period.

=head3 write_cache_pc

Returns an L object for the percentage of the write cache usage
for the node.

=head3 refresh_system_stats

This method refreshes all system statistics with updated values from the system.  This
method may be handy if instantiate an IBM::StorageSystem object within a long running or non-exiting
process and wish to either periodically retrieve updated system statistics.

B that you can call B on individual system statistics which may have a slight
performance increase over this method.

=head3 stats_threshold

This method allows you specify the statistics threshold freshness interval in seconds. This
interval is used to determine if the value sreturned by a statistics method are fresh or
whether they should be refreshed from the atregt system.

By default this value is zero, meaning that the statistics are never refreshed unless explicitly
done so by calling the B method of the statistic object.  This may result in a
performance increase in situations where statistic methods are frequently used, and may also
result in more consistent reporting of the target system state as the statistic values will more
closely represent a single point in time overview of the system rather than a series of
consecutive snapshots.

In situation where you may want to gather a set of statistical values for the target system over
a finite period, you could set the threshold value low, and reset it afterwards. e.g.

	# Print the current FC IOPS value every two seconds for a minute
	$ibm->stats_threshold = 1;
	for ( 1 .. 30 ) {
		print $ibm->fc_io_current;
		sleep 2
	}
	# Disable automatic refreshing
	$ibm->stats_threshold = 0;

=head3 array( $id )

        # Print the capacity and RAID level of array 1 in GB
        my $array = $ibm->array( 1 );
        print "Array 1 capacity: " . int ( $array->capacity / ( 1024 ** 3 ) )
                . " (" . $array->raid_level . ")\n"

        # e.g. Array 1 capacity: 5824G (raid10)

Returns an L object representing the array specified by the numerical
id parameter.

B that this is a caching method and that a previously retrieved L object will
be returned if one has been cached from previous invocations.

=head3 get_array( $id )

Returns the array specified by the value of the numerical ID argument as an L object.

B that this method is non-caching and the array information will always be retrieved from the StorageSystem
system even if a cached object exists.

=head3 get_arrays

        # Print the array status of all arrays in our system
        map { print "Array ", $_->mdisk_id, " status ", $_->status, "\n" } $ibm->get_arrays;

Returns an array of L objects representing all arrays in the target system.

=head3 drive ( $id )

        # Get drive ID 2 as an IBM::StorageSystem::Drive object
        my $drive = $ibm->drive( 2 );

        # Print the drive capacity in bytes
        print $drive->capacity;

        # Alternately;
        print $ibm->drive( 2 )->capacity;

        # Print the drive vendor and product IDs
        print "Vendor ID: ", $drive->vendor_id, " - Product ID: ", $drive->product_id, "\n";

Returns the drive specified by the value of the integer argument as a L object.

B that this method implements caching and that a cached object will be retrieved if present.

If you require a non-cached object, then use the B method instead.

=head3 get_drive( $id )

Returns the drive specified by the value of the integer argument.  This method is non-caching and
always retrieves information directly from the target system even if a cached object is present.

=head3 get_drives( $id )

        # Print the SAS port status and drive status for all drives in a nicely formatted list
        printf("%-20s%-20s%-20s%-20s\n", 'Drive', 'SAS Port 1 Status', 'SAS Port 2 Status', 'Status');
        printf("%-20s%-20s%-20s%-20s\n", '-'x18, '-'x18, '-'x18, '-'x18);
        map { printf( "%-20s%-20s%-20s%-20s\n", $_->id, $_->port_1_status, $_->port_2_status, $_->status) } $ibm->get_drives;

        # e.g.
        # Drive               SAS Port 1 Status   SAS Port 2 Status   Status
        # ------------------  ------------------  ------------------  ------------------
        # 0                   online              online              online
        # 1                   online              online              online
        # 2                   online              online              online
        # 3                   online              online              online
        # ...

Returns all drives as an array of L objects.

=head3 enclosure( $id )

        # Print the status of a specific enclosure
        print "Enclosure two status is " . $ibm->enclosure(2)->status . "\n";

        # Get all PSUs in an enclosure as L objects.
        my @psus = $ibm->enclosure(1)->psus;

Returns the enclosure specified by the numerical identifer of the id parameter as an
L object.

B that this is a caching method and that a cached object will be returned if one is present.
If you require a non-cached result, then please use the B method.

=head3 get_enclosure( $id )

This method is a functionally equivalent non-caching implementation of the B method.

=head3 get_enclosures

        # Print the status of each enclosure in our system.
        foreach my $enclosure ( $ibm->get_enclosures ) {
                print "Enclosure ", $enclosure->id, " status: ", $enclosure->status, "\n"
        }

Returns an array of L objects representing all enclosures present in teh target
system.

=head3 host( $hostname )

        # Print the host status of the attached host 'sauron'
        print "Status: " . $ibm->host(sauron)->status . "\n";

Returns the host specified by the value of the named host parameter as an L object.

B that this is a caching method and a cached object will be returned if one exists.  If you require
a non-cached object, then please use the B method.

=head3 get_host( $hostname )

This is a functionally equivalent non-caching implementation of the B method.

=head3 get_hosts

        # Print a list of all configured hosts sorted by hostname, their WWPNs,
        # port state and login status.

        foreach $host ( map { $_->[0] } sort { $a->[1] cmp $b->[1] } map { [ $_, $_->name ] } $ibm->get_hosts ) {
                my $c = 0;

                foreach $wwpn ( @{ $host->WWPN } ) {
                        print ( $c ? "\t" : ('-'x100)."\n".$host->name );
                        print "\t\t\t$wwpn\t" . @{ $host->state }[$c] . "\t\t" .
                                ( @{$host->node_logged_in_count }[$c] ? '' : 'not ' ) . "logged in\n";
                        $c++
                }
        }

        # Prints something similar to:
        # ----------------------------------------------------------------------------------------------------
        # host-3                        2101001B32A3D94C        active          logged in
        #                               2100001B3283D94C        active          logged in
        # ----------------------------------------------------------------------------------------------------
        # host-4                        2100001B320786E7        active          logged in
        #                               2101001B322786E7        active          logged in
        # ----------------------------------------------------------------------------------------------------
        # storage-2                     210100E08BB40A08        offline         not logged in
        #                               210000E08B940A08        offline         not logged in
        # ... etc.

Returns an array of L objects representing all host attached to the target system.

=head3 iogroup( $id )

        # Get I/O group 0
        my $io_group = $ibm->get_iogroup(0);

        # Print the I/O group maintenance state
        print $io_group->maintenance_state;

        # Alternately:
        print $ibm->iogroup(0)->maintenance_state;

Returns the I/O group identified by the value of the numerical ID parameter as an L
object.

B that this method implements caching and a cached object will be returned shoudl one be present.
If you require a non-cached object then please use the B method.

=head3 get_iogroup( $id )

This is a functionally equivalent non-caching implementation of the B method.

=head3 get_iogroups

        # Print a formatted listing of all I/O groups by ID and name, along with
        # their VDisk count, host count, node count and maintenance state.
        map { printf("%-8s%-20s%-20s%-20s%-20s%-20s\n",
                $_->id,
                $_->name,
                $_->vdisk_count,
                $_->host_count,
                $_->node_count,
                $_->maintenance )
        } $ibm->get_iogroups;

        # Prints something like:
        #
        # ID      Name                VDisk Count         Host Count          Node Count          Maintenance
        # 0       io_grp0             2                   3                   2                   no
        # 1       io_grp1             0                   3                   0                   no
        # 2       io_grp2             0                   3                   0                   no
        # 3       io_grp3             0                   3                   0                   no
        # ... etc.

Returns an array of L objects representing all configured I/O groups on the target system.

=head3 vdisk( $id )

        # Get the VDisk ID 3 and print the VDisk UUID
        my $vdisk = $ibm->vdisk(3);
        print $vdisk->vdisk_UUID;

        # Alternately:
        print $ibm->vdisk(3)->vdisk_UUID;

Returns an L object representing the VDisk identified by the numerical ID parameter.

B that this method implements caching to improve performance and reduce network overhead, and that a cached
object will be returned if one is present.  If you require a non-cached object then please use the B
method.

=head3 get_vdisk( $id )

This is a functionally equivalent non-caching implementation of the B method.

=head3 get_vdisks

        # Print the name, ID, capacity in GB and MDisk group name of all VDisks in a
        # nicely formatted output
        printf( "%-20s%-8s%-15s%20s\n", 'Name', 'ID', 'Capacity (GB)', 'MDisk Group Name' );
        printf( "%-20s%-8s%-15s%20s\n", '-'x18, '-'x4, '-'x12, '-'x15 );
        map { printf( "%-20s%-8s%-15s%20s\n", $_->name, $_->id, (int($_->capacity / (1024**3))), $_->mdisk_grp_name) }
        grep { $_->status eq 'online' } $ibm->get_vdisks;

        # Should print something like:
        # Name                ID      Capacity (GB)      MDisk Group Name
        # ------------------  ----    ------------       ---------------
        # file-host-1         0       5823               FILE_POOL
        # backup-host-2       1       2330               BACKUP_POOL
        # ... etc.

Returns all configured VDisks in the target system as an array of L objects.

=head1 AUTHOR

Luke Poskitt, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc IBM::V7000



=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2013 Luke Poskitt.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.


=cut

1;