Metadata-Version: 1.1
Name: brocade-tool
Version: 0.1.11
Summary: Monitors Brocades
Home-page: https://github.tagged.com/siteops/brocade-tool
Author: Brian Glogower
Author-email: brian@glogower.org
License: Apache v2.0
Description: brocade-tool
        ============
        
        System Requirements
        -------------------
        
        -  Python >= 2.6 and Python < 3
        -  Python modules are in requirements.txt
        
        Installation
        ------------
        
        From PyPI
        ~~~~~~~~~
        
        **Notes**
        
        -  Don't forget to `modify <#configure>`__ **/etc/brocadetool.conf**
           after installation
        
           ::
        
               sudo pip install netscaler-tool
               sudo mkdir -p /var/log/brocade-tool
               sudo touch /var/log/brocade-tool/brocade-tool.log
               sudo chown <user>:<group> /var/log/brocade-tool/brocade-tool.log
               sudo chmod <mode> /var/log/brocade-tool/brocade-tool.log
               sudo wget -O /etc/brocadetool.conf https://github.com/tagged/brocade-tool/blob/master/brocadetool.conf.example
        
        From Source
        ~~~~~~~~~~~
        
        #. git clone https://github.com/tagged/brocade-tool.git
        #. cd brocade-tool
        #. sudo python setup.py install
        #. sudo mkdir -p /var/log/brocade-tool
        #. sudo touch /var/log/brocade-tool/brocade-tool.log
        #. sudo chown <user>:<group> /var/log/brocade-tool/brocade-tool.log
        #. sudo chmod <mode> /var/log/brocade-tool/brocade-tool.log
        #. sudo cp brocadetool.conf.example /etc/brocadetool.conf
        #. Modify /etc/brocadetool.conf
        
        Configuration
        -------------
        All changes should be made in /etc/brocadetool.conf
        
        #. Set previous_data_path to the path where brocade-tool where store metric for any OIDs that have rate option set.
        #. Set **passwd** with the SNMP community password
        #. Set **oids**
        
           - If you want to turn a counter into a gauge, specify 'rate'
        #. (Optional)
        
           -  Set carbon values, if you plan to send metric to a carbon
        
        Usage
        -----
        
        Currently, the brocade-tool is used for monitoring. Enter all the OIDs you want to monitor in the /etc/brocadetool.conf yaml file and that is it.
        
        ::
        
            brocade-tool --help
            usage: brocade-tool [-h] [--passwd PASSWD] [--dryrun] [--debug] [--verbose]
                                [--carbon]
                                BROCADE {show} ...
        
            positional arguments:
              BROCADE          IP or name of Brocade
              {show}
                show           sub-command for showing objects
        
            optional arguments:
              -h, --help       show this help message and exit
              --passwd PASSWD  Community password for brocade user. Default is to fetch
                               from brocadetool.conf
              --dryrun         Dryrun
              --debug          Shows what's going on
              --verbose, -v    Shows more info
              --carbon         Send data to carbon?
        
            brocade-tool brocade01 show --help
            usage: brocade-tool BROCADE show [-h] {ports} ...
        
            positional arguments:
              {ports}
                ports     sub-command for showing stats about all ports
        
            optional arguments:
              -h, --help  show this help message and exit
        
        By default, brocade-tool will query the brocade device for all specified
        OIDs. If you wish to have it only query a sub set of OIDs, you can use **--stat**
        
        ::
        
            brocade-tool brocade01 show ports --stat swFCPortTxWords swFCPortRxWords
Keywords: Automation,Brocade,Networking
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: System :: Operating System
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
