The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Cisco-UCS-0.30
River stage zero No dependents
1 ++
/ Cisco::UCS::Common::FanModule

NAME

Cisco::UCS::Common::FanModule - Class for operations with a Cisco UCS Fan Module

SYNOPSIS

  print "Fan module " . $ucs->chassis(1)->fan_module(1)->id .
        " thermal: " . $ucs->chassis(1)->fan_module(1)->thermal . "\n";

  my @fans = $ucs->chassis(1)->fan_module(1)->get_fans;

DESCRIPTION

Cisco::UCS::Common::FanModule is a class providing operations with a Cisco UCS Fan Module.

Note that you are not supposed to call the constructor yourself, rather a Cisco::UCS::Common::FanModule is created automatically via method calls to a Cisco::UCS::Chassis object like fan_module.

METHODS

fan ($id)

  my $fan = $ucs->chassis(1)->fan_module(1)->fan(2);

Returns a Cisco::UCS::Common::Fan object for the specified fan module identified by the provided fan ID.

Note that the default behaviour for this method is to return a cached object retrieved by a previous lookup if one is available. Please see the Caching Methods section in NOTES for further information.

get_fan ($id)

  my $fan = $ucs->chassis(2)->fan_module(1)->get_fan(1);

Returns a Cisco::UCS::Common::Fan object identified by the given fan ID.

This method always queries the UCSM for information on the specified fan - contrast this with the behaviour of the analogous caching method fan().

get_fans

  my @fans = $ucs->get_chassis(2)->fan_module(1)->get_fans;

Returns an array of Cisco::UCS::Common::Fan objects. This is a non-caching method.

dn

Returns the distinguished name of the Cisco::UCS::Common::FanModule in the Cisco UCS management hierarchy.

id

Returns the numerical ID of the fan module.

model

Returns the model number of the fan module.

operability

Returns the operability status of the fan module.

oper_state

Returns the operational state of the fan module.

performance

Returns the performance status of the fan module.

power

Returns the power status of the fan module.

presence

Returns the presence status of the fan module.

revision

Returns the revision number of the fan module object.

serial

Returns the serial number of the fan module.

thermal

Returns the thermal status of the fan module.

tray

Returns the tray identifier in which the fan module is installed.

vendor

Returns the vendor information for the fan module.

voltage

Returns the voltage status of the fan module.

AUTHOR

Luke Poskitt, <ltp at cpan.org>

BUGS

Please report any bugs or feature requests to bug-cisco-ucs-common-fanmodule at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Cisco-UCS-Chassis-FanModule. 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 Cisco::UCS::Chassis::FanModule

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.