  [1mNAME[0m
    Cisco::ACI - Perl interface to the Cisco APIC API.

  [1mSYNOPSIS[0m
    This module provides a Perl interface to Cisco APIC API.

        use Cisco::ACI;

        my $aci = Cisco::ACI->new(
                            username=> $username,
                            password=> $password,
                            server  => $server
        );

        # Required!
        $aci->login;

        # Get the leaf nodes of the pod as an array of
        # Cisco::ACI::FabricNode objects.
        my @leafs = $aci->get_leafs;

        # Same but for spines (both leaf and spine nodes
        # are Cisco::ACI::FabricNode objects).
        my @spines = $aci->get_spines;

        # Or, get a leaf by ID - still returns a 
        # Cisco::ACI::FabricNode object.
        my $leaf = $aci->(101);

        # Do some interesting stuff with it.
        # Like, get the 5min measurements of policy CAM (TCAM) usage
        # as a Cisco::ACI::Eqptcapacity::PolUsage object.
        my $pol_usage = $leaf->PolUsage( '5min' );

        # So now we can calculate the policy CAM utilisation
        my $pol_utilisation = ( $pol_usage->polUsageCum 
                                    / $pol_usage->polUsageCapCum ) * 100;

        # Or get the number of faults present
        my $faults = $leaf->fault_counts;

        printf( 'Node %s has %d Minor, %d Major, %d Warning, and %d Critical faults\n',
                    $leaf->name,
                    $faults->minor,
                    $faults->maj,
                    $faults->warn,
                    $faults->crit );
   
        # And much more...

  [1mMETHODS[0m
   new ( %ARGS )
    Constructor. Creates a new Cisco::ACI object. This method accepts three
    mandatory and two optional named parameters:

    [1musername[0m
        The username with which to connect to the Cisco APIC API.

    [1mpassword[0m
        The password with which to connect to the Cisco APIC API.

    [1mserver[0m
        The resolvable hostname of the Cisco ACI APIC to connect to.

    [1mport[0m
        The TCP port on which to connect to the Cisco ACI APIC, if not
        specified this parameter will default to a value of 443, which is
        probably what you want.

    [1mproto[0m
        The protocol to use when connecting to the Cisco ACI APIC, if not
        specified this parameter will default to a value of 'https', which is
        probably what you want.

   bd_constraint ()
    Returns the maximum configurable number Bridge Domains (fvBD) in the
    fabric.

   bd_count ()
    Returns the number of configured Bridge Domains (fvBD) in the fabric.

   cluster_appliances ()
    Returns all APICs in the cluster as an array of Cisco::ACI::Infra::WiNode
    objects. Note that APICs are also separately represented as devices of
    type Cisco::ACI::FabricNode within the Cisco APIC MO (see method
    [1mcontrollers()[0m).

   cluster_standby_appliances ()
    Returns all standby APICs in the cluster as an array of
    Cisco::ACI::Infra::SnNode objects.

   concrete_devices_constraint ()
    Returns the maximum configurable number concrete devices (vnsCDev) in the
    fabric.

   concrete_devices_count ()
    Returns the number of configured concrete devices (vnsCDev) in the fabric.

   contract_constraint ()
    Returns the maximum configurable number contracts (vzBrCP) in the fabric.

   contract_count ()
    Returns the number of configured contracts (vzBrCP) in the fabric.

   controllers ()
    Returns all APICs in the cluster as an array of Cisco::ACI::FabricNode
    objects. Note that APICs are also separately represented as devices of
    type Cisco::ACI::Infra::WiNode within the Cisco APIC MO (see method
    [1mcluster_appliances()[0m).

   controller ( $ID )
    Returns the APIC identified by the $ID parameter as a
    Cisco::ACI::FabricNode object. Note that APICs are numbered sequentially
    starting from 1.

   ep_constraint ()
    Returns the maximum configurable number end points (fvCEp) in the fabric.

   ep_count ()
    Returns the number of configured end points (fvCEp) in the fabric.

   epg_constraint ()
    Returns the maximum configurable number end point groups (fvAEPg) in the
    fabric.

   epg_count ()
    Returns the number of configured end point groups (fvAEPg) in the fabric.

   fabric_links ()
    Returns all fabric links as an array of Cisco::ACI::Fabric::Link objects.

   faults ()
    Returns all fabric faults as an array of Cisco::ACI::Fault::Inst objects.

   fexs ()
    Returns all fabric extendeds (fexs) as an array of Cisco::ACI::Eqpt::ExtCh
    objects.

   get_capability_rules ()
    Returns all capacity rules as an array of Cisco::ACI::FvcapRule objects.

   health ()
    Returns the fabric health as an array of Cisco::ACI::Health::Inst objects.

   leaf ( $ID )
    Returns the leaf node identified the the [1m$ID[0m parameter as a
    Cisco::ACI::FabricNode object.

   leafs ()
    Returns all leaf nodes as an array of Cisco::ACI::FabricNode objects.

   login ()
    Perfoms a login to the ACI APIC API - note that merely calling the
    constructor does not automatically log you into the fabric. Rather you are
    required to invoke this method to do so.

   overallHealth5min ()
    Returns the overall health of the fabric for the previous fivce minute
    interval as an Cisco::ACI::Stats::Curr::OverallHealth object.

   service_graph_constraint ()
    Returns the maximum configurable number of service graphs (vnsGraphInst)
    in the fabric.

   service_graph_count ()
    Returns the number of configured service graphs (vnsGraphInst) in the
    fabric.

   spine ( $ID )
    Returns the spine node identified the the [1m$ID[0m parameter as a
    Cisco::ACI::FabricNode object.

   spines ()
    Returns all spine nodes as an array of Cisco::ACI::FabricNode objects.

   tenant ( $TENANT )
    Returns the tenant identified by the $TENANT parameter as a
    Cisco::ACI:Tenant object.

   tenant_constraint ()
    Returns the maximum configurable number of tenant (fvTenant) in the
    fabric.

   tenant_count ()
    Returns the number of configured tenants (fvTenant) in the fabric.

   vrf_constraint ()
    Returns the maximum configurable number of VRFs (fvCtx) in the fabric.

   vrf_count ()
    Returns the number of configured VRFs (fvCtx) in the fabric.

  [1mAUTHOR[0m
    Luke Poskitt, "<ltp at cpan.org>"

  [1mBUGS[0m
    Please report any bugs or feature requests to "bug-cisco-aci at
    rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Cisco-ACI>. I will be
    notified, and then you'll automatically be notified of progress on your
    bug as I make changes.

  [1mSUPPORT[0m
    You can find documentation for this module with the perldoc command.

        perldoc Cisco::ACI

    You can also look for information at:

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

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

    *   AnnoCPAN: Annotated CPAN documentation

        <http://annocpan.org/dist/Cisco-ACI>

    *   CPAN Ratings

        <http://cpanratings.perl.org/d/Cisco-ACI>

    *   Search CPAN

        <http://search.cpan.org/dist/Cisco-ACI/>

  [1mLICENSE AND COPYRIGHT[0m

This software is Copyright (c) 2019 by WENWU YAN.

This is free software, licensed under:

  The (two-clause) FreeBSD License

The FreeBSD License

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the
     distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
