Supported Versions
Brocade Network Advisor 14.4.2
BNA REST API - 14.4.2


Brocade Network Advisor (BNA) provides comprehensive management for Fibre Channel and IP storage networks including Brocade-specific solutions including third-party vendors as well.

As a BNA administrator, you can:

  • Get a comprehensive view of the managed inventory.
  • Collect availability and performance metrics of managed resources (Fabrics, switches, and ports).
  • Collect uptime status across all discovered resources and generate alerts on specific switches or ports based on configured thresholds.
  • Classify and report all switches whose CPU & memory utilization breaches configured thresholds.
  • Based on configured thresholds, collect availability & uptime status across all discovered resources and be alerted on specific switches/ports.
  • BNA generates a set of events from underlying devices and reports into the BNA console. OpsRamp integration ingest these events on a periodic poll and generate corresponding alerts. These alerts are posted on the resources that are created in OpsRamp.
  • At Least one alert should be created, in order to see the tags in alert escalation policy.
Linux Install Integration
  • While generating Alerts on port related metrics with the help labels, BNA provides Switch and Fabric details.
Linux Install Integration

Below are some of the Broadcom device series supported by BNA.

  • Brocade Gen 6 Fibre Channel platforms
  • Brocade Gen 5 Fibre Channel platforms
  • Brocade DCX® Backbone family
  • Brocade VDX switches
  • Emulex adapters
  • QLogic adapters

Supported Metrics

Click here to view the supported metrics
ComponentMetric NameMetric Display NameUnits
Switchbna_switch_OperationalStatusBNA Switch status-
bna_switch_StateBNA Switch state-
bna_switch_memory_UtilizationBNA Switch memory utilization-
bna_switch_cpu_UtilizationBNA Switch CPU utilizationpercent
bna_switch_TemperatureBNA Switch Temperaturecentigrade
bna_switch_FanSpeedBNA Switch Fan speedrevolutions per minute
bna_switch_SystemUpTimeBNA Switch Up timeseconds
bna_switch_PortNotInUseBNA Switch port not in usecount
Portbna_port_StatusBNA port status-
bna_port_StateBNA port state-
bna_port_RX_UtilizationBNA port RX utilizationpercent
bna_port_TX_UtilizationBNA port TX utilizationpercent
bna_port_TrafficBNA port trafficmegabytes/second
bna_port_TX_TrafficBNA port TX Trafficmegabytes/second
bna_port_CrcErrorsBNA port crc errorserrors/second
bna_port_RX_Link_ResetsBNA port RX Link resetserrors/second
bna_port_TX_Link_ResetsBNA port TX Link resetserrors/second
bna_port_SignalLossesBNA port Signal losseserrors/second
bna_port_SyncLossesBNA port sync losseserrors/second
bna_port_LinkFailuresBNA port link failureserrors/second
bna_port_SequenceErrorsBNA port sequence errorserrors/second
bna_port_InvalidTransactionsBNA port invalid transactionserrors/second
bna_port_C3DiscardsBNA port c3discardserrors/second
bna_port_TX_C3Discards_TimeOutBNA port c3discards TX timeouterrors/second
bna_port_RX_C3Discards_TimeOutBNA port c3discards RX timeouterrors per second
bna_port_C3Discards_UnReachableBNA port c3discards Un Reachableerrors per second
bna_port_C3Discards_OthersBNA port c3discards Otherserrors/second
bna_port_EncodeErrorOutBNA port encode error outerrors/second
bna_port_TX_SFP_PowerBNA port sfp power-
bna_port_RX_SFP_PowerBNA port sfp rx power-
bna_port_SFP_VoltageBNA port sfp voltage-
bna_port_SFP_CurrentBNA port sfp current-
bna_port_SFP_TemperatureBNA port sfp temperaturecentigrade
bna_port_Invalid_OrderedSetsBNA port invalid ordered setserrors/second
bna_port_bb_credit_ZeroBNA port bb credit zeroerrors/second
bna_port_TruncatedFramesBNA port truncated frameserrors/second

OpsRamp configuration

Install the integration

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.
  6. Click ADD on the Brocade Network Advisor tile.
  7. From Install Brocade Network Advisor Integration, enter the following details:
    • Name: Name of the integration.
    • Upload Logo: Brocade Network Advisor device logo.
    • Gateway Profile: Select a gateway management profile to associate with the client.
  8. Click Install.

The BROCADE-NETWORK-ADVISOR INTEGRATION page displays the installed integration under the CONFIGURATION section.

Configure the integration

  1. From CONFIGURATION, click + Add.

  2. In the Create Adapter Configuration page, enter the following details:

    • Name: Configuration name.
    • Protocol:
      • HTTPS: Secure connection.
      • HTTP: If the connection is not secure.
    • BNA IP Address: Target device IP address.

  3. From the Credentials section, select Custom and enter the target device Username and Password.

  4. From Resource Types & Metrics, select the metrics and Availability.
    The Resource Types & Metrics section displays the target device resource type such as Brocade Network Advisor.

  5. From the Metrics section select the metrics you want.
    Use Import to import metrics to OpsRamp and Export to save metric details locally.

  6. In the Discovery Schedule section, select a Recurrence Pattern to add one of the following:

    • Hourly
    • Daily
    • Weekly
    • Monthly
  7. In the Monitoring Schedule section, select the target device monitoring frequency.
    The default frequency is 30 minutes.

  8. Click Save.

After saving the integration, Brocade Network Advisor resources are discovered and monitoring is enabled as specified by the configured metric criteria.

View the Brocade Network Advisor details

The Brocade Network Advisor is successfully integrated and displayed in the Infrastructure > Server category. The server selection further categorizes the resources as Fabrics, Switches, and Port sections.

Note: The current available BNA lab contains a total of 386 ports across 4 switches. Discovery time and resource creation will vary based on total discoverable objects.

Resource Model Representation

BNA Domain ObjectOpsRamp Resource TypeComment
FabricFabricA generic resource type to represent fabrics needs to be created.
PortNetwork PortNot Available
BNA ServerServerAvailable (Resource Type: Server)
SwitchSwitchAvailable (Path: Network Device >> Switch)
OpsRamp Resources (Target)RelationshipOpsRamp Resources (Source)
FabricDepends-OnBNA Server
SwitchDepends-OnBNA Server
PortDepends-OnBNA Server

Resource Attribute Mapping

BNA Domain ObjectBNA Domain AttributeOpsRamp Resource
IP AddressipAddress
Product TyperesourceType
Serial #serialNumber
Factory Serial #

Ex: 16Gb 96 FC Ports Fabric Switch
Discovery Status

State: Online

Status: Healthy - monitoring metric
Port Count

Fabric ID to which this switch is associated with. To be managed through relationships

A World Wide Name (WWN) or World Wide Identifier (WWID) is a unique identifier used in storage technologies
serial #serialNumber
serial #serialNumber

Purpose of Brocade Error Dumping Hosts

The templates for Brocade Error Dumping enable OpsRamp to extract an error dump from a Brocade Switch and store it on a host (Windows or Linux server). The error dump contains diagnostic information that OpsRamp uses to monitor the Brocade switches.

Where are the Brocade Error Templates configured

The templates are configured on any Linux or Windows servers that have network access to the Brocade Switches being monitored. It is a pre-requisite though that these servers have the OpsRamp agent installed.

Preparation of Linux or Windows servers that will host error dumps from Brocade Switches


  • Template Name: Brocade ErrDump Monitor – Linux
  • Prerequisites:
    • This monitor works on python 3 version.
    • yaml and paramiko python modules
    • Linux machine should be able to access the target Brocade switch.
    • Need to provide yaml file path as command line argument
    • Need to place the yaml file on Linux machine:
      • Default Path Installation: /opt/opsramp/agent/log/prevstate/brocade_errdump.yaml
      • Custom Path Installation: {custom_dir}/opsramp/agent/log/prevstate/brocade_errdump.yaml


  • Template Name: Brocade ErrDump Monitor – Windows
  • Prerequisites:
    • This monitor works on python 3 version.
    • yaml and paramiko python modules
    • Windows machine should be able to access the target Brocade switch.
    • Need to provide yaml file path as command line argument.
    • Need to place the yaml file on Windows machine:
      • Default Path Installation: C:\Program Files (x86)\OpsRamp\Agent\log\prevstate\brocade_errdump.yaml
      • Custom Path Installation: {custom_dir}\OpsRamp\Agent\log\prevstate\brocade_errdump.yaml

Risks, Limitations & Assumptions

  • The availability is shown unknown for few resources even if it is enabled on the respective resource metrics. This is because of the presence of multiple native type resources under the same resource type.
  • Availability metric selection is mandatory while adding the adapter configuration.