The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
IBM-StorageSystem-0.045
River stage one • 3 direct dependents • 3 total dependents
++
/ IBM::StorageSystem::Node

NAME

IBM::StorageSystem::Node - Class for operations with a IBM StorageSystem node

VERSION

Version 0.01

SYNOPSIS

IBM::StorageSystem::Node is a utility class for operations with a IBM StorageSystem node.

        use IBM::StorageSystem;
        
        my $ibm = IBM::StorageSystem->new(      
                                        user            => 'admin',
                                        host            => 'my-v7000',
                                        key_path        => '/path/to/my/.ssh/private_key'
                                ) or die "Couldn't create object! $!\n";
        
        # Get node mgmt001st001 as an IBM::StorageSystem::Node object
        my $node = $ibm->node( mgmt001st001 );
        
        # Print the node description
        print "Description: " . $node->description . "\n";

        # Prints something like: "Description: active management node"
        # Or alternately;
        print "Description: " . $ibm->node( mgmt001st001 )->description . "\n";
        
        # Print the GPFS status of all nodes
        foreach my $node ( $ibm->get_nodes ) {
                print "GPFS status: " . $node->GPFS_status . "\n"
        }

        # Print the node product version
        print $node->product_version;

        # Print the node connection status
        print $node->connection_status;

METHODS

CTDB_status

Returns the Clustered Trivial Database Status (CTDB) status of the specified node.

connection_status

Returns the connection status of the specified node.

CTDB_IP_address

Returns the CTDB IP address of the specified node.

cpu( $timeperiod )

Returns a IBM::StorageSystem::Statistic::Node::CPU object containing CPU statistics and performance data for the specified node for the specified time period.

Valid values for the timeperiod parameter are one of minute, hour, day, week, month, quarter and year - if the timeperiod parameter is not specified it will default to minute.

daemon_IP_address

Returns the daemon IP address of the specified node.

daemon_version

Returns the daemon version number.

description

Returns the node description.

disk_reads( $time_period )

Returns a IBM::StorageSystem::StatisticsSet object containing a chronological set of IBM::StorageSystem::Statistic::Node::DiskRead objects, each of which represent a single performance measurement of read operations for all GPFS disks on the target node.

The optional time period parameter specifies the period over which the performance data was measured and may be one of minute, hour, day, week, month, quarter or year - if no time period is specified this value will default to minute.

disk_writes( $time_period )

Returns a IBM::StorageSystem::StatisticsSet object containing a chronological set of IBM::StorageSystem::Statistic::Node::DiskRead objects, each of which represent a single performance measurement of write operations for all GPFS disks on the target node.

The optional time period parameter specifies the period over which the performance data was measured and may be one of minute, hour, day, week, month, quarter or year - if no time period is specified this value will default to minute.

GPFS_status

Returns the General Paralell File System (GPFS) status of the specified node.

hostname

Returns the hostname of the specified node.

IP

Returns the IP address of the specified node.

is_cache

Returns the cache status of the specified node.

is_manager

Returns the manager status of the specified node.

is_quorum

Returns the quorum status of the specified node.

last_updated

Returns the time at which the CTDB status of the node was last updated.

memory( $timperiod )

Returns a IBM::StorageSystem::Statistics::Node::Memory object containing memory statistics and performance data for the specified node for the specified time period.

Valid values for the timeperiod parameter are one of minute, hour, day, week, month, quarter and year - if the timeperiod parameter is not specified it will default to minute.

monitoring_enabled

Returns the monitoring enablement status of the specified node.

OS_family

Returns the operating system family type of the specified node.

OS_name

Returns the operating system name of the specified node.

product_version

Returns the product version number of the specified node.

recovery_master

Returns the recovery master status of the specified node.

role

Returns the role of the specified node.

serial_number

Returns the serial number of the specified node.

username

Returns the username used for management of the specified node.

version

Returns the version of the specified node.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

Please report any bugs or feature requests to bug-ibm-v7000-node at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IBM-StorageSystem-Node. 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 IBM::StorageSystem::Node

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2012 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.