Skip to main content

System Requirements

  • Python >= 2.6 and Python < 3

  • Python modules are in requirements.txt

Installation

From PyPI

Notes

  • Don’t forget to modify /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

  1. git clone https://github.com/tagged/brocade-tool.git

  2. cd brocade-tool

  3. sudo python setup.py install

  4. sudo mkdir -p /var/log/brocade-tool

  5. sudo touch /var/log/brocade-tool/brocade-tool.log

  6. sudo chown <user>:<group> /var/log/brocade-tool/brocade-tool.log

  7. sudo chmod <mode> /var/log/brocade-tool/brocade-tool.log

  8. sudo cp brocadetool.conf.example /etc/brocadetool.conf

  9. Modify /etc/brocadetool.conf

Configuration

All changes should be made in /etc/brocadetool.conf

  1. Set previous_data_path to the path where brocade-tool where store metric for any OIDs that have rate option set.

  2. Set passwd with the SNMP community password

  3. Set oids

    • If you want to turn a counter into a gauge, specify ‘rate’

  4. (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

Release files for brocade-tool 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for brocade-tool 0.1.11
File Size Uploaded
brocade-tool-0.1.11.tar.gz 12.9 kB Details

Release files / brocade-tool-0.1.11.tar.gz

Download URL brocade-tool-0.1.11.tar.gz
Size 12.9 kB
Tags Source
SHA-256 checksum
How to use checksums
48a4afae70256e1b61dc313014468b76e79c36866cb67407110204b9233c70e9
BLAKE2b-256 checksum
How to use checksums
0bc57c35daddcd2810b10213aab446f8d7c811f512e19bd72a7c1cce5d5e2c90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.11 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page