GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Cisco::UCS::Common::EthernetPort(3) User Contributed Perl Documentation Cisco::UCS::Common::EthernetPort(3)

Cisco::UCS::Common::EthernetPort - Class for operations with a Cisco UCS Ethernet Port. 

    print "FI A port 1/2 operational_speed is " 
                . $ucs->interconnect(A)->card(1)->eth_port(2)->oper_speed;
                . ', total bytes transmitted is "
                . $ucs->interconnect(A)->card(1)->eth_port(1)->tx_total_bytes
                . ".\n";

    # Prints: 
    # FI A port 1/2 operational_speed is 10gbps, total bytes transmitted is 120230320434028.

Cisco::UCS::Common::EthernetPort is a class used to represent a single Ethernet port in a Cisco::UCS system. This class provides functionality to retrieve information and statistics for Ethernet ports.

Please note that you should not need to call the constructor directly as Cisco::UCS::Common::EthernetPort objects are created for you automatically via methods in other Cisco::UCS packages like the i<get_ports> method in Cisco::UCS::Interconnect.

Dependent on UCSM version, some attributes of the Ethernet port may not be provided and hence the accessor methods may return an empty string.

The administrative state of the port.

The numeric id of the chassis to which this port is connected. This value will be blank for port that are configured as network uplinks.

The distinguished name of the port in the Cisco UCS management heirarchy.

The dn of the object to which the remote end of this port is connected.

The port number in the relevant to the current slot.

The role of the port. e.g. 'server' for server links or 'network' for network uplinks.

The type of the port - either physical or virtual.

The user-defined label given to the port (may be blank).

The license state of the port.

The MAC address of the port.

The access mode of the port.

The UCS management heirarchy distinguished name of the peer port to which this port is connected.

The numerical identifier of the peer port to which this port is connected.

The operational state of the port.

The operational speed of the port.

The physical interface receiver type.

The id of the Fabric Interconnect on which the port is located.

The network type of the port.

The statistics methods listed below allow retrieval of interface counter statistical data. These methods fall into three broad categories; transmit (tx), receive (rx) and error (err).

All statistical methods are implemented in both a non-caching and caching form; non-caching methods always query the UCSM for data retrieval and therefore may be more expensive in terms of system and network resources than the equivalent caching method. Non-caching methods are always named using the form: 

   get_<type>_<counter_name>

Where type is one of rx, tx or err as described in the STATISTICS METHODS section above, and counter_name is the name of the counter as per the section below.

Caching methods return a cached result retrieved during a previous query if available, if cached data retrieved from a previous query is not available, then a the UCSM is queried for the requested data. Caching methods are named using the same form as non-caching methods excluding the prefix get_.

Because UCSM queries may be expensive it is important to note the way in which caching has been implemented and the potential side-effects that this may have. In brief, when a non-caching method is executed for a particular counter type (tx, rx or err) either implicitly or explicitly, all other available counters for that type are also retrieved and cached.

This may introduce side-effects and action-at-a-distance and thus, and Cisco::UCS::Common::EthernetPort objects cannot be considered reentrant.

Transmit, receive and error counter data share the following common methods that are a function of the underlying collection method.

Returns the number of counter collection intervals that have elapsed since the last clearing of interface counters.

Returns the timestamp of the last time that the counter was updated.

Returns a true value if the counter information is suspect, returns null otherwise.

Returns the (assumed) update number for the retrieved statistics data.

The methods listed below are common to transmit and receive methods with the implied understanding that transmit refers to counter values for data out and receive refers to counter data for traffic in.

Returns the number of tranmitted or received broadcast packets for the specified interface.

Returns the delta value of the number of transmitted or received broadcast packets for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received broadcast packets for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received broadcast packets for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received broadcast packets for the specified interface between the current and previous collection period.

Returns the number of transmitted or received jumbo packets for the specified interface between the current and previous collection period.

Returns the delta value of the number of transmitted or received jumbo packets for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received jumbo packets for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received jumbo packets for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received jumbo packets for the specified interface between the current and previous collection period.

Returns the number of transmitted or received multicast packets for the specified interface between the current and previous collection period.

Returns the delta value of the number of transmitted or received multicast packets for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received multicast packets for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received multicast packets for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received multicast packets for the specified interface between the current and previous collection period.

Returns the number of transmitted or received bytes for the specified interface between the current and previous collection period.

Returns the delta value of the number of transmitted or received bytes for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received bytes for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received bytes for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received bytes for the specified interface between the current and previous collection period.

Returns the number of transmitted or received packets for the specified interface between the current and previous collection period.

Returns the delta value of the number of transmitted or received packets for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received packets for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received packets for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received packets for the specified interface between the current and previous collection period.

Returns the number of transmitted or received unicast packets for the specified interface between the current and previous collection period.

Returns the delta value of the number of transmitted or received unicast packets for the specified interface between the current and previous collection period.

Returns the average delta value of the number of transmitted or received unicast packets for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of transmitted or received unicast packets for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of transmitted or received unicast packets for the specified interface between the current and previous collection period.

Returns the number of allignment errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of alignment errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of alignment errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of alignment errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of alignment errors for the specified interface between the current and previous collection period.

Returns the number of deferrment errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of deferrment errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of deferrment errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of deferrment errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of deferrment errors for the specified interface between the current and previous collection period.

Returns the number of frame check sequence errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of frame check sequence errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of frame check sequence errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of frame check sequence errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of frame check sequence errors for the specified interface between the current and previous collection period.

Returns the number of interface MAC transmit errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of interface MAC transmit errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of interface MAC transmit errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of interface MAC transmit errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of interface MAC transmit errors for the specified interface between the current and previous collection period.

Returns the number of interface MAC receive errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of interface MAC receive errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of interface MAC receive errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of interface MAC receive errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of interface MAC receive errors for the specified interface between the current and previous collection period.

Returns the number of out-discard errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of out-discard errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of out-discard errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of out-discard errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of out-discard errors for the specified interface between the current and previous collection period.

Returns the number of rcv-err errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of rcv-err errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of rcv-err errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of rcv-err errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of rcv-err errors for the specified interface between the current and previous collection period.

Returns the number of undersize errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of undersize errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of undersize errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of undersize errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of undersize errors for the specified interface between the current and previous collection period.

Returns the number of xmit-err errors for the specified interface between the current and previous collection period.

Returns the delta value of the number of xmit-err errors for the specified interface between the current and previous collection period.

Returns the average delta value of the number of xmit-err errors for the specified interface between the current and previous collection period.

Returns the minimum delta value of the number of xmit-err errors for the specified interface between the current and previous collection period.

Returns the maximum delta value of the number of xmit-err errors for the specified interface between the current and previous collection period.

Luke Poskitt, "<ltp at cpan.org>"

Please report any bugs or feature requests to "bug-cisco-ucs-common-ethernetport at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Cisco-UCS-Common-EthernetPort>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

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

    perldoc Cisco::UCS::Common::EthernetPort

You can also look for information at:

  • RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Cisco-UCS-Common-EthernetPort>

  • AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/Cisco-UCS-Common-EthernetPort>

  • CPAN Ratings

    <http://cpanratings.perl.org/d/Cisco-UCS-Common-EthernetPort>

  • Search CPAN

    <http://search.cpan.org/dist/Cisco-UCS-Common-EthernetPort/>

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.

2016-05-25 perl v5.32.1
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.