/ 
IBM-StorageSystem-0.045
River stage one • 3 direct dependents • 3 total dependents
/ IBM::StorageSystem::Interface

NAME

IBM::StorageSystem::Interface - Class for operations with a IBM StorageSystem network interfaces

VERSION

Version 0.01

SYNOPSIS

IBM::StorageSystem::Interface - Class for operations with a IBM StorageSystem network interfaces

        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 interface ethX0 on management node mgmt001st001 as an IBM::StorageSystem::Interface object
	my $interface = $ibm->interface('mgmt001st001:ethX0');

	# Print the interface status
	print $interface->up_or_down;

	# Print the interface status
	print $interface->speed;

	# Alternately;
	print $ibm->interface('mgmt001st001:ethX0')->speed;

	# Print a list of all interfaces, the node on which they reside,
	# their status, speed and role
	
	foreach my $interface ( $ibm->get_interfaces ) {
		print "Node: " . $interface->node . "\n";
		print "Interface: " . $interface->interface . "\n";
		print "\tStatus: " . $interface->up_or_down . "\n";
		print "\tSpeed: " . $interface->speed . "\n";
		print "\tRole: " . $interface->subordinate_or_master . "\n----------\n";
	}

METHODS

bonding_mode

Returns the interface bonding mode - Note that this attribute will likely be null for subordinate interfaces.

IP_addresses

Returns the IP address(es) associated with the interface - note that this may be a single address, a comma-separated list of multiple addresses or null.

interface

Returns the interface system name (e.g. ethX1).

MAC

Returns the MAC (Media Access Controll) address of the interface. <BNote> that the MAC address is returned in a URL percent encoded string - i.e. the colon character is encoded as the string "%3A".

MTU

Returns the MTU (Maximum Transmissable Unit) for the interface in MD.

master_or_subordinate

Returns the role of the interface - either MASTER or SUBORDINATE.

node

returns the node on which the interface resides.

speed

Returns the interfaces media speed in MB/s.

transmit_hash_policy

Returns the interface transmit hash policy - Note that this attribute will likely be null for subordinate interfaces.

up_or_down

Returns the up or down state of the interface - either UP or DOWN.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

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

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.