Page is loading ...
Brocade SANnav Management Portal and Global View User
Guide, 1.1.1
User Guide
22 March 2019
SANnav-111-UG101
22 March 2019
Copyright
©
2019 Broadcom. All Rights Reserved. Broadcom, the pulse logo, Brocade, and the stylized B logo are among
the trademarks of Broadcom in the United States, the EU, and/or other countries. The term “Broadcom” refers to
Broadcom Inc. and/or its subsidiaries.
Broadcom reserves the right to make changes without further notice to any products or data herein to improve reliability,
function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom does
not assume any liability arising out of the application or use of this information, nor the application or use of any product or
circuit described herein, neither does it convey any license under its patent rights nor the rights of others.
The product described by this document may contain open source software covered by the GNU General Public License
or other open source license agreements. To find out which open source software is included in Broadcom products, view
the licensing terms applicable to the open source software, and obtain a copy of the programming source code, please
visit https://www.broadcom.com/.
Table of Contents
Chapter 1: Introduction......................................................................................................................13
1.1 About This Document.............................................................................................................................................. 13
1.2 What Is New in This Document............................................................................................................................... 13
1.3 Supported Hardware and Software.........................................................................................................................13
1.4 Contacting Technical Support for Your Brocade
®
Product..................................................................................14
1.5 Document Feedback................................................................................................................................................ 15
Chapter 2: Installation........................................................................................................................16
2.1 Installation Overview................................................................................................................................................16
2.2 SANnav Management Portal Deployment..............................................................................................................16
2.2.1 System and Server Requirements for SANnav Management Portal................................................................17
2.2.2 Installation Prerequisites for SANnav Management Portal.............................................................................. 18
2.2.3 Installing the Application for Single-Node Deployment.................................................................................... 19
2.2.4 Installing the Application for Multi-Node Deployment.......................................................................................20
2.2.5 Firewall Requirements for SANnav Management Portal..................................................................................22
2.3 SANnav Global View Deployment...........................................................................................................................23
2.3.1 System and Server Requirements for SANnav Global View............................................................................24
2.3.2 Installation Prerequisites for SANnav Global View...........................................................................................24
2.3.3 Installing the Application...................................................................................................................................25
2.3.4 Firewall Requirements for SANnav Global View..............................................................................................27
2.4 Uninstalling the SANnav Application..................................................................................................................... 28
2.5 Additional Scripts.....................................................................................................................................................28
2.6 Configuring a Firewall for SANnav......................................................................................................................... 30
2.7 Example of Provisioning a VM for SANnav Installation........................................................................................31
Chapter 3: Getting Started with SANnav Management Portal....................................................... 38
3.1 SANnav Overview.....................................................................................................................................................38
3.2 Browser Requirements............................................................................................................................................ 38
3.3 Launching SANnav Management Portal................................................................................................................ 39
3.4 Overview of the User Interface................................................................................................................................39
3.4.1 Tags..................................................................................................................................................................42
3.4.1.1 Tagging Objects.................................................................................................................................... 42
3.4.2 Filter Management........................................................................................................................................... 45
3.4.2.1 Creating Filters......................................................................................................................................46
3.4.2.2 Creating Temporary and Permanent Filters.......................................................................................... 47
3.4.2.3 Deleting Filters...................................................................................................................................... 48
3.4.3 Context Search.................................................................................................................................................49
3.5 Changing Your Password........................................................................................................................................50
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
3
3.6 Initial Setup and Configuration............................................................................................................................... 51
Chapter 4: Licensing..........................................................................................................................54
4.1 SANnav Licensing Overview...................................................................................................................................54
4.2 SANnav Licensing Terminology..............................................................................................................................54
4.3 SANnav License Types............................................................................................................................................ 54
4.4 Managed Port Count................................................................................................................................................ 55
4.5 How SANnav Licensing Works............................................................................................................................... 55
4.6 Obtaining the Server UID.........................................................................................................................................57
4.7 Generating a License............................................................................................................................................... 57
4.8 Adding a License to SANnav...................................................................................................................................59
4.9 Managing the Port Count ........................................................................................................................................61
4.10 Renewing a License............................................................................................................................................... 62
4.11 Moving a License to a Different Server: Planned Migration............................................................................... 63
4.12 Moving a License to a Different Server: Unplanned Migration.......................................................................... 64
4.13 Deleting a License..................................................................................................................................................64
4.14 Querying a License................................................................................................................................................ 64
Chapter 5: Security............................................................................................................................ 66
5.1 User Management.....................................................................................................................................................66
5.1.1 Configuring Password, Lockout, and Session Policies.................................................................................... 68
5.1.2 Creating Custom Roles.................................................................................................................................... 69
5.1.3 Creating Custom AORs....................................................................................................................................70
5.1.4 Creating a User Account.................................................................................................................................. 71
5.2 Unlocking a User Account.......................................................................................................................................72
5.3 SANnav Management Portal User Account Privileges......................................................................................... 73
5.4 Configuring SANnav to Use an External Server for Authentication....................................................................74
5.5 LDAP Server Configuration.....................................................................................................................................76
5.5.1 Adding LDAP Servers to the Docker Container............................................................................................... 77
5.5.2 Creating Role and AOR Custom Attributes in the LDAP Active Directory........................................................78
5.5.3 Assigning Roles and AORs to Users on the LDAP Server...............................................................................79
5.5.4 Assigning Roles and AORs to LDAP Groups in SANnav.................................................................................80
5.6 RADIUS Server Configuration.................................................................................................................................80
5.6.1 Configuring SANnav Credentials on the RADIUS Server................................................................................ 81
5.6.2 Assigning Roles and AORs to Users on the RADIUS Server.......................................................................... 82
5.6.3 Configuring Role and AOR Attributes on the RADIUS Server......................................................................... 83
5.7 TACACS+ Server Configuration..............................................................................................................................83
5.7.1 Assigning Roles and AORs to Users on the TACACS+ Server....................................................................... 84
5.8 Managing Signed Certificates................................................................................................................................. 85
Chapter 6: Monitoring........................................................................................................................ 86
6.1 Discovery.................................................................................................................................................................. 86
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
4
6.1.1 Discovering a Fabric.........................................................................................................................................87
6.1.2 Stopping Switch Monitoring..............................................................................................................................89
6.1.3 Stopping Fabric Monitoring.............................................................................................................................. 90
6.1.4 Resuming Switch Monitoring............................................................................................................................91
6.1.5 Resuming Fabric Monitoring............................................................................................................................ 92
6.1.6 Rediscovering a Switch....................................................................................................................................93
6.1.7 Rediscovering a Fabric.....................................................................................................................................94
6.1.8 Changing the Seed Switch...............................................................................................................................95
6.1.9 Deleting a Fabric.............................................................................................................................................. 96
6.1.10 Configuring Fabric Tracking........................................................................................................................... 97
6.1.11 Updating Fabric Members.............................................................................................................................. 98
6.2 Dashboards...............................................................................................................................................................99
6.2.1 Changing the Favorite Dashboard................................................................................................................. 100
6.2.2 Creating Custom Content for a Dashboard View........................................................................................... 101
6.2.3 Setting Network Scope and Date Range........................................................................................................106
6.2.4 Viewing Existing Dashboards.........................................................................................................................109
6.2.5 Sharing the Dashboard with Other Users....................................................................................................... 111
6.2.6 Health Summary Dashboard.......................................................................................................................... 111
6.2.6.1 Understanding How Health Score Is Computed..................................................................................113
6.2.6.2 Monitoring SAN Health and Status Daily.............................................................................................113
6.2.6.3 Factors Contributing to the Overall Health Score................................................................................115
6.2.7 Network Port Traffic Conditions Dashboard................................................................................................... 117
6.2.7.1 Troubleshooting Mode.........................................................................................................................118
6.2.7.2 Congestion Severity States.................................................................................................................122
6.3 Reports....................................................................................................................................................................123
6.3.1 Configuring Report Content............................................................................................................................124
6.3.1.1 Creating a Useful Report.....................................................................................................................130
6.3.2 Editing Report Content...................................................................................................................................134
6.3.3 Scheduling a Report.......................................................................................................................................137
6.3.4 Viewing, Exporting, and Deleting On-demand Reports..................................................................................139
6.4 Widgets for Dashboards and Reports..................................................................................................................141
6.4.1 Performance Widgets.....................................................................................................................................144
6.4.2 Status Widgets - Dashboard.......................................................................................................................... 147
6.4.3 Status Widgets - Reports............................................................................................................................... 148
6.5 Performance Monitoring........................................................................................................................................148
6.5.1 Enabling Historical Data Collection................................................................................................................ 149
6.5.2 Launching Investigate Mode.......................................................................................................................... 150
6.5.2.1 Creating a Selected Items Container for Investigate Mode.................................................................152
6.5.3 Using Investigation Mode...............................................................................................................................153
6.5.4 Scheduling High Granularity Data Collection................................................................................................. 158
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
5
6.5.4.1 Data Collection Output........................................................................................................................160
6.6 Inventory Management.......................................................................................................................................... 164
6.6.1 Adding Custom Fields to a Managed Object..................................................................................................165
6.6.2 Identifying Switches to Plan for an Upgrade.................................................................................................. 168
6.6.3 Putting a Switch in Maintenance Mode.......................................................................................................... 170
6.6.4 Disabling and Enabling a Switch....................................................................................................................171
6.6.5 Disabling and Enabling a Switch Port............................................................................................................ 171
6.6.6 Decommissioning Ports..................................................................................................................................172
6.6.7 Renaming Switch Ports, Switches, and Fabrics.............................................................................................173
6.6.8 Creating Host and Storage Enclosures..........................................................................................................175
6.6.9 Mapping Host and Storage Ports................................................................................................................... 176
6.6.10 Converting Initiator and Target Device Types...............................................................................................178
6.6.11 Launching Web Tools................................................................................................................................... 179
6.6.12 Managing Trunk Inventory............................................................................................................................180
6.6.13 Exporting Inventory Names and Mapping.................................................................................................... 180
6.6.14 Importing Inventory Names and Mapping.................................................................................................... 181
6.7 Topology Visualization...........................................................................................................................................182
6.7.1 Viewing the Fabric Topology.......................................................................................................................... 184
6.7.2 Showing All Devices in a Fabric.....................................................................................................................188
6.7.3 Viewing Connectivity between Hosts and Storage.........................................................................................190
6.7.4 Viewing a Zone Topology............................................................................................................................... 192
Chapter 7: Configuration................................................................................................................. 194
7.1 Policy-Based Configuration.................................................................................................................................. 194
7.1.1 Creating a Configuration Policy......................................................................................................................194
7.1.2 Configuring a New Switch Before Adding It to the Fabric.............................................................................. 198
7.1.3 Configuring a New Switch After Adding It to the Fabric................................................................................. 199
7.1.4 Monitoring Configuration Drifts.......................................................................................................................200
7.1.5 Resolving Configuration Drifts........................................................................................................................202
7.1.6 Configuration Blocks...................................................................................................................................... 203
7.2 Switch Configuration Backup and Restore..........................................................................................................209
7.2.1 Backing Up Switch Configurations................................................................................................................. 210
7.2.2 Restoring a Configuration...............................................................................................................................211
7.2.3 Managing Switch Configuration Backups.......................................................................................................212
7.3 Event Management.................................................................................................................................................213
7.3.1 Functions of Event Management....................................................................................................................214
7.3.2 Types of Registration......................................................................................................................................214
7.3.3 Registering for SNMP Traps.......................................................................................................................... 214
7.3.4 Registering for Syslog.................................................................................................................................... 215
7.3.4.1 Importing the Server Syslog Certificate Using a CLI Script................................................................216
7.3.5 Enabling or Disabling SNMP Informs.............................................................................................................218
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
6
7.3.6 Enabling Event Notifications...........................................................................................................................219
7.3.7 Setting the Frequency to Receive Email Event Notifications......................................................................... 219
7.3.8 Configuring an Email Setup............................................................................................................................220
7.3.9 Defining Trap Configuration........................................................................................................................... 221
7.3.10 Forwarding................................................................................................................................................... 222
7.3.10.1 Filtering Traps and Messages...........................................................................................................222
7.3.10.2 Adding a Forwarding Destination......................................................................................................225
7.3.10.3 Adding Trap Forwarding Credentials................................................................................................ 226
7.3.11 Managing Event Actions...............................................................................................................................227
7.3.11.1 Configuring Identification and Action.................................................................................................227
7.3.11.2 Creating Events and Policy............................................................................................................... 229
7.3.11.3 Creating Sources...............................................................................................................................231
7.3.11.4 Creating Event Action with Critical Event on Events and Policy...................................................... 233
7.3.11.5 Using Event Action to Suppress Selected Events............................................................................237
7.3.11.6 Auto Acknowledging Events Based on Event Description............................................................... 240
7.3.12 Adding an Event Filter from Filter Management...........................................................................................244
7.3.13 Adding an Event Filter in the Events Tab..................................................................................................... 246
7.3.14 Searching Events......................................................................................................................................... 249
7.3.15 Viewing Violations........................................................................................................................................ 249
7.3.16 Acknowledging or Unacknowledging the Events..........................................................................................250
7.3.17 Setting Event Management Reports and Dashboard Widgets.....................................................................251
7.3.17.1 Exporting Event Management Reports............................................................................................. 255
7.4 Call Home and ESRS..............................................................................................................................................256
7.4.1 Supporting the SANnav License for Call Centers ......................................................................................... 256
7.4.2 Call Home Events...........................................................................................................................................256
7.4.3 Configuring Call Home Notification................................................................................................................ 257
7.4.4 Configuring the Dell EMC Call Home Support Center....................................................................................259
7.4.5 Enabling and Disabling a Call Home Center..................................................................................................261
7.4.6 Call Home Email Notifications........................................................................................................................262
7.5 Zoning .....................................................................................................................................................................262
7.5.1 Zone Database Size.......................................................................................................................................262
7.5.2 Naming Conventions......................................................................................................................................262
7.5.3 Creating Zone Aliases....................................................................................................................................263
7.5.3.1 Importing Zone Aliases....................................................................................................................... 264
7.5.3.2 Exporting Zone Aliases....................................................................................................................... 264
7.5.4 Configuring Zones in a Fabric........................................................................................................................ 265
7.5.4.1 Creating Standard Zones...................................................................................................................266
7.5.4.2 Creating Peer Zones..........................................................................................................................266
7.5.4.3 Creating LSAN Zones........................................................................................................................ 268
7.5.4.4 Creating LSAN Peer Zones................................................................................................................269
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
7
7.5.5 Creating Zone Configurations........................................................................................................................ 270
7.5.5.1 Saving the Inactive ZoneDB to the Offline ZoneDB............................................................................273
7.5.6 Offline Zoning.................................................................................................................................................273
7.5.6.1 Creating Offline Zone Configurations.................................................................................................273
7.5.6.2 Creating Offline Zones....................................................................................................................... 278
7.5.7 Creating Peer Zones with a Simplified Workflow........................................................................................... 280
7.5.8 Configuring the Zoning Policy........................................................................................................................ 282
7.5.9 Modifying a Zone Configuration..................................................................................................................... 283
7.5.10 Comparing Active and Active Modified Zone Configurations....................................................................... 288
7.6 Virtual Fabrics.........................................................................................................................................................291
7.6.1 Supported Platforms for Virtual Fabrics......................................................................................................... 291
7.6.2 RBAC for Logical Fabric Management Feature............................................................................................. 292
7.6.3 Creating a Logical Fabric............................................................................................................................... 292
7.6.4 Adding Logical Switches to a Logical Fabric..................................................................................................294
7.6.5 Activating a Logical Fabric............................................................................................................................. 299
7.6.5.1 Deployment Behavior..........................................................................................................................301
7.6.5.2 Post Deployment Behavior..................................................................................................................303
7.6.6 Editing Logical Fabrics and Switches.............................................................................................................303
7.6.6.1 Editing a Logical Switch...................................................................................................................... 305
7.6.7 Deleting Logical Fabrics and Switches...........................................................................................................307
7.6.7.1 Deleting a Logical Switch....................................................................................................................308
7.6.8 Fabric Properties for Logical Fabrics..............................................................................................................309
7.6.9 Viewing the Deployment Logs of the Logical Fabric...................................................................................... 310
7.6.10 Deleting the Deployment Logs..................................................................................................................... 311
7.6.11 Logical Fabric Events................................................................................................................................... 312
7.7 Monitoring and Alerting Policy Suite....................................................................................................................313
7.7.1 MAPS Structural Elements.............................................................................................................................314
7.7.2 MAPS Actions................................................................................................................................................ 314
7.7.3 MAPS Categories...........................................................................................................................................316
7.7.4 MAPS Groups................................................................................................................................................ 317
7.7.5 MAPS Violations.............................................................................................................................................318
7.7.5.1 Viewing MAPS Violations....................................................................................................................319
7.7.6 MAPS Rules...................................................................................................................................................319
7.7.7 MAPS Conditions........................................................................................................................................... 320
7.7.8 MAPS Policies................................................................................................................................................320
7.7.9 MAPS Measures............................................................................................................................................ 321
7.7.9.1 Port Health.......................................................................................................................................... 322
7.7.9.2 Switch Policy Status............................................................................................................................323
7.7.9.3 Fabric State Changes......................................................................................................................... 324
7.7.9.4 FRU Health......................................................................................................................................... 325
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
8
7.7.9.5 Security Health....................................................................................................................................326
7.7.9.6 Switch Resources............................................................................................................................... 327
7.7.9.7 Extension Tunnel................................................................................................................................ 327
7.7.9.8 Traffic /Flows Performance................................................................................................................. 328
7.7.9.9 FPI.......................................................................................................................................................329
7.7.9.10 GigE Port...........................................................................................................................................329
7.7.9.11 Backend Port Monitoring...................................................................................................................330
7.7.10 MAPS Configuration.....................................................................................................................................330
7.7.10.1 Configuring a MAPS Policy and Applying It to Multiple Switches..................................................... 331
7.7.10.2 Managing MAPS Configure Actions on a Switch.............................................................................. 332
7.7.10.3 Enabling or Disabling Policy Actions on the Switch.......................................................................... 340
7.7.10.4 Configuring an Email Notification for MAPS......................................................................................341
7.8 Fibre Channel Routing...........................................................................................................................................342
7.8.1 License Requirements for Fibre Channel Routing......................................................................................... 342
7.8.2 Supported Platforms for Fibre Channel Routing............................................................................................ 343
7.8.3 Limitations of Fibre Channel Routing............................................................................................................. 343
7.8.4 Configuring a Backbone Fabric......................................................................................................................344
7.8.5 Editing a Backbone Fabric............................................................................................................................. 346
7.8.6 Viewing FCR in Topology............................................................................................................................... 348
7.9 vCenter Discovery..................................................................................................................................................351
7.9.1 Adding vCenter...............................................................................................................................................352
7.9.2 Monitoring or Unmonitoring the ESXi Hosts...................................................................................................352
7.9.3 Rediscovering ESXi Hosts............................................................................................................................. 352
7.9.4 Viewing the ESXi Host Properties..................................................................................................................353
7.9.5 Investigating the Virtual Machines..................................................................................................................354
7.9.6 Viewing the Virtual Machine Properties..........................................................................................................355
7.9.7 Viewing ESXi Hosts in Topology.................................................................................................................... 356
7.9.8 Creating a VM Alarms Dashboard..................................................................................................................358
Chapter 8: Extension Tunnels and Circuits................................................................................... 360
8.1 Extension Tunnels Overview.................................................................................................................................360
8.2 Configuring IPSec Policy.......................................................................................................................................360
8.2.1 Editing a Policy...............................................................................................................................................361
8.2.2 Create a New Policy.......................................................................................................................................364
8.2.3 Delete a Policy............................................................................................................................................... 366
8.3 Setting up Extension Tunnels............................................................................................................................... 366
8.3.1 Editing the Extension Tunnel..........................................................................................................................373
8.3.2 Deleting a Tunnel........................................................................................................................................... 375
Chapter 9: Switch Maintenance and Support................................................................................ 377
9.1 Firmware Management...........................................................................................................................................377
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
9
9.1.1 Importing Firmware Files to the Repository....................................................................................................377
9.1.2 Managing the Repository............................................................................................................................... 379
9.1.3 Updating a Selected Switch from an Internal or External Location ............................................................... 379
9.1.4 Updating the Firmware for One or More Switches from an Internal or External Location..............................383
9.2 Switch SupportSave...............................................................................................................................................387
9.2.1 Requirements.................................................................................................................................................388
9.2.2 Generating SupportSave for One or More Switches......................................................................................388
9.2.3 Scheduling SupportSave for One or More Switches......................................................................................390
9.2.4 Configuring Trace Dump................................................................................................................................ 391
9.2.5 Managing the Switch SupportSave Files........................................................................................................392
Chapter 10: SANnav Management Portal Maintenance and Support..........................................394
10.1 SANnav Backup and Restore..............................................................................................................................394
10.1.1 Configuring a Scheduled Backup.................................................................................................................395
10.1.2 On-demand Backup..................................................................................................................................... 397
10.1.3 On-demand Backup Using CLI Script.......................................................................................................... 397
10.1.4 Restoring......................................................................................................................................................398
10.2 Management Portal Server Support Data Collection ....................................................................................... 399
10.2.1 Generating the Support Data Collection File................................................................................................399
10.2.2 Splitting and Merging SANnav Support Data Files.......................................................................................400
10.2.2.1 Splitting SANnav Support Data Files................................................................................................ 401
10.2.2.2 Merging SANnav Support Data Files................................................................................................ 401
10.2.3 Downloading the Support Data Collection Files ..........................................................................................401
10.2.4 Sending Support Data Collection Files to an FTP Server............................................................................ 402
10.2.5 Deleting the Support Data Collection Files...................................................................................................402
Chapter 11: Troubleshooting...........................................................................................................403
11.1 Master Node Failure............................................................................................................................................. 403
11.2 Worker Node Failure.............................................................................................................................................403
Chapter 12: SANnav Global View....................................................................................................404
12.1 Overview of SANnav Global View.......................................................................................................................404
12.2 SANnav Global View Compatibility Matrix.........................................................................................................404
12.3 Logging In to SANnav Global View.....................................................................................................................404
12.4 Quick Tour of SANnav Global View.................................................................................................................... 404
12.5 Global View Licensing......................................................................................................................................... 406
12.6 Creating a New User Account............................................................................................................................. 406
12.6.1 Global View Authentication and Authorization............................................................................................. 408
12.7 Adding a SANnav Management Portal Instance................................................................................................408
12.8 Global Dashboard Overview................................................................................................................................409
12.8.1 Monitoring Fabric Health.............................................................................................................................. 410
12.8.2 Monitoring Switch Health Across Management Portal Instances.................................................................412
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
10
12.8.3 Displaying Port Usage Details......................................................................................................................415
12.8.4 Viewing Alerts...............................................................................................................................................417
12.9 Creating Report Content......................................................................................................................................419
12.10 Global View Inventory Management.................................................................................................................425
12.10.1 Switch Inventory.........................................................................................................................................426
12.10.2 Switch Port Inventory................................................................................................................................. 428
12.10.3 Investigate Switch Ports.............................................................................................................................430
12.11 Global View Events.............................................................................................................................................434
12.12 Global View Password and Lockout Policy..................................................................................................... 436
12.13 Global View Support Data Collection............................................................................................................... 438
12.14 Global View Backup........................................................................................................................................... 439
12.15 Global View Email Setup....................................................................................................................................439
Chapter 13: Exporting Select Configurations from Brocade Network Advisor to
SANnav Management Portal........................................................................................................... 440
13.1 Exporting Select Configurations Overview........................................................................................................440
13.2 Exporting End Device Names..............................................................................................................................440
13.3 Importing End Device Names as Zone Aliases..................................................................................................440
13.4 Exporting Host or Storage Port Mapping...........................................................................................................441
13.5 Importing Host or Storage Port Mapping...........................................................................................................441
13.6 Exporting a MAPS Policy.....................................................................................................................................442
13.7 Importing MAPS Policies.....................................................................................................................................442
Chapter 14: SANnav Management Portal REST API Overview.................................................... 443
14.1 Overall REST API Strategy.................................................................................................................................. 443
14.2 Using the SANnav Management Portal REST API.............................................................................................444
14.3 SANnav Management Portal Examples..............................................................................................................444
14.3.1 Discovery Module.........................................................................................................................................445
14.3.2 FCR Module................................................................................................................................................. 447
14.3.3 Fault Module.................................................................................................................................................449
Chapter 15: Revision History.......................................................................................................... 455
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
11
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
12
Introduction
1.1 About This Document
This guide describes how to monitor and manage your storage area network (SAN) using Brocade SANnav Management
Portal and Brocade SANnav Global View. This guide also includes installation procedures.
Within this document, information that pertains to both SANnav Management Portal and SANnav Global View products is
referred to simply as "SANnav", whereas information that pertains to only one or the other references the specific product.
1.2 What Is New in This Document
This document includes new and modified information for the SANnav 1.1.1 release.
n
The Installation chapter has the following changes:
– Added the default database and SCP/SFTP passwords.
– Added a note to the system and server requirements that the disk space requirement is for SANnav only and does
not include space for the operating system and for saving files.
n
Removed Edge from the list of supported browsers.
n
Added the "Splitting and Merging SANnav Support Data Files" section to the "SANnav Management Portal
Maintenance and Support" chapter.
n
Incorporated editorial comments throughout the document.
1.3 Supported Hardware and Software
SANnav 1.1.1 supports the following Fabic OS software versions and hardware platforms.
Fabric OS Software Support
The following Fabric OS software versions are supported by this release of SANnav.
n
Fabric OS 7.4 or later
n
Fabric OS 8.x or later
NOTE
SANnav 1.1.1 is not qualified or supported in FICON environments.
Brocade Gen 6 (32Gb/s) Fixed-Port Switches
n
Brocade G610 Switch
n
Brocade G620 Switch
n
Brocade G630 Switch
n
Brocade 7810 Extension Switch
Brocade Gen 6 (32Gb/s) Directors
n
Brocade X6-4 Director
n
Brocade X6-8 Director
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
13
Brocade Gen 5 (16Gb/s) Fixed-Port Switches
n
Brocade 6505 Switch
n
Brocade 6510 Switch
n
Brocade 6520 Switch
n
Brocade M6505 Blade Server SAN I/O module
n
Brocade 6542 Blade Server SAN I/O module
n
Brocade 6543 Blade Server SAN I/O module
n
Brocade 6545 Blade Server SAN I/O module
n
Brocade 6546 Blade Server SAN I/O module
n
Brocade 6547 Blade Server SAN I/O module
n
Brocade 6548 Blade Server SAN I/O module
n
Brocade 6558 Blade Server SAN I/O module
n
Brocade 7840 Extension Switch
Brocade Gen 5 (16Gb/s) Directors
n
Brocade DCX 8510-4 Director
n
Brocade DCX 8510-8 Director
Brocade Gen 4 (8Gb/s) Fixed-Port Switches
n
Brocade 300 Switch
n
Brocade 5100 Switch
n
Brocade 5300 Switch
n
Brocade 5410 Blade Server SAN I/O module
n
Brocade 5424 Blade Server SAN I/O module
n
Brocade 5430 Blade Server SAN I/O module
n
Brocade 5431 Blade Server SAN I/O module
n
Brocade 5432 Blade Server SAN I/O module
n
Brocade 5450 Blade Server SAN I/O module
n
Brocade 5460 Blade Server SAN I/O module
n
Brocade 5470 Blade Server SAN I/O module
n
Brocade 5480 Blade Server SAN I/O module
n
Brocade NC-5480 Blade Server SAN I/O module
n
Brocade 7800 Extension Switch
n
Brocade Encryption Switch
n
Brocade VA-40FC Switch
Brocade Gen 4 (8Gb/s) Directors
n
Brocade DCX
n
Brocade DCX-4S
1.4 Contacting Technical Support for Your Brocade
®
Product
For product support information and the latest information on contacting the Technical Assistance Center, go to https://
www.broadcom.com/support/fibre-channel-networking/. If you have purchased Brocade
®
product support directly from
Broadcom, use one of the following methods to contact the Technical Assistance Center 24x7.
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
14
Online Telephone
For nonurgent issues, the preferred method is to log in to
myBroadcom at https://www.broadcom.com/mybroadcom. (You
must initially register to gain access to the Customer Support
Portal.) Once there, select Customer Support Portal > Support
Portal. You will now be able to navigate to the following sites:
n
Knowledge Search: Clicking the top-right magnifying glass
brings up a search bar.
n
Case Management: The legacy MyBrocade case
management tool (MyCases) has been replaced with the Fibre
Channel Networking case management tool.
n
DocSafe: You can download software and documentation.
n
Other Resources: Licensing Portal (top), SAN Health (top and
bottom), Communities (top), Education (top).
Required for Severity 1 (critical) issues:
Please call Fibre Channel Networking Global Support at one of the
numbers listed at https://www.broadcom.com/support/fibre-
channel-networking/.
If you purchased Brocade product support from a Broadcom OEM/solution provider, contact your OEM/solution provider
for all your product support needs.
n
OEM/solution providers are trained and certified by Broadcom to support Brocade products.
n
Broadcom provides backline support for issues that cannot be resolved by the OEM/solution provider.
n
Brocade Supplemental Support augments your existing OEM support contract, providing direct access to Brocade
expertise. For more information on this option, contact Broadcom or your OEM.
n
For questions regarding service levels and response times, contact your OEM/solution provider.
1.5 Document Feedback
Quality is our first concern. We have made every effort to ensure the accuracy and completeness of this document.
However, if you find an error or an omission or if you think that a topic needs further development, we want to hear from
you. Send your feedback to [email protected]. Provide the publication title, publication number, topic
heading, page number, and as much detail as possible.
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
15
Installation
2.1 Installation Overview
The SANnav application uses a script-based installation. You must run the scripts that are provided in the <install_home>
directory to install the application. All the scripts for the SANnav application must be executed in bash shell.
The following installations are supported:
n
SANnav Management Portal
– Single-node Installation
– Multi-node Installation
n
SANnav Global View
– Single-node Installation
NOTE
SANnav Management Portal and SANnav Global View are two different software products. You cannot install
both software products on the same physical host or virtual machine.
If there is a firewall between the client and server or between the server and SAN, you must open a set of ports for
SANnav to function properly. The list of ports is provided in sections Firewall Requirements for SANnav Management
Portal and Firewall Requirements for SANnav Global View.
2.2 SANnav Management Portal Deployment
SANnav Management Portal provides single-node and multi-node installation. During the installation, you are prompted
several times to accept default values or provide customized values for various settings.
For a multi-node installation, you can install SANnav on a cluster of three physical servers or on a cluster of three virtual
machines. You assign one node as a master node. The remaining two nodes are assigned as worker nodes.
The multi-node installation includes additional steps that must be performed on the master node and both of the worker
nodes.
Installation Customizations
The following customizations are supported in the installation phase:
n
Setting server-to-switch communication protocol preference. The following is the list of available protocol options:
n
0 for HTTP (Insecure communication)
n
1 for HTTPS (Secure communication. Requires that you have an IT-provided SSL cert (or self-signed cert) and that
your switches are configured for HTTPS.)
n
2 for HTTPS then HTTP (First HTTPS is tried and if that fails, HTTP is used.)
n
Port Customization — You can customize ports when installing SANnav Management Portal. To use a default port, that
port must be unused and available. The following is the list of default values:
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
16
– Client to Server HTTPS Port: Default HTTPS port is 443
– SNMP Trap: Default SNMP trap port is 162
– Syslog Port: Default syslog port is 514
– Secure Syslog Port: Default Secure syslog port is 6514
– Database Port: 5432
n
Database Password — You can change the default SANnav Management Portal database password. You will be given
an option to proceed installation with the default password or choose a new password for the SANnav database. The
default password is passw0rd (where 0 is a zero).
n
SCP/SFTP Password — You can change the default SCP/SFTP password. You will be given an option to proceed
installation with the default password or choose a new password for the internal SCP/SFTP server. The default
password is passw0rd (where 0 is a zero).
2.2.1 System and Server Requirements for SANnav Management Portal
It is mandatory to meet all the system and server requirements before you start SANnav Management Portal installation.
NOTE
For a multi-node installation, the maximum number of managed ports is the sum of the ports managed by the
master node and each worker node, and cannot exceed 15,000.
The following table lists the system and server requirements for single-node and multi-node deployment for SANnav
Management Portal.
NOTE
The disk space requirement listed in the table is for SANnav only. Be sure to account for additional space
required by the operating system and for saving files.
The disk space can be from a direct-attached disk or through a network-mounted disk.
Table 1: System and Server Requirements for Single-Node and Multi-Node Installation
Single-Node Multi-Node
Requirement 3000 Ports 15,000 Ports Master Node Each Worker Node
Operating system
n
Red Hat Enterprise
Linux: 7.4 and 7.5
n
CentOS 7.5
n
Red Hat Enterprise
Linux: 7.4 and 7.5
n
CentOS 7.5
n
Red Hat Enterprise
Linux: 7.4 and 7.5
n
CentOS 7.5
n
Red Hat Enterprise
Linux: 7.4 and 7.5
n
CentOS 7.5
Host type
n
Bare metal server
n
VMware ESXi virtual
machine
n
Bare metal server
n
VMware ESXi virtual
machine
n
Bare metal server
n
VMware ESXi virtual
machine
n
Bare metal server
n
VMware ESXi virtual
machine
CPU 16 cores 24 cores 16 cores 16 cores on each worker
node
CPU sockets
(minimum)
2 2 2 2 on each worker node
CPU speed
(minimum)
2000 MHz 2000 MHz 2000 MHz 2000 MHz on each worker
node
Memory (RAM) 48 GB 96 GB 32 GB 32 GB on each worker
node
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
17
Table 1: System and Server Requirements for Single-Node and Multi-Node Installation (Continued)
Single-Node Multi-Node
Requirement 3000 Ports 15,000 Ports Master Node Each Worker Node
Hard disk space
(minimum)
600 GB, distributed as
follows:
n
450 GB - Installation
folder
n
120 GB - /var/lib
n
20 GB - "/"
n
250 MB - /etc
1.2 TB, distributed as
follows:
n
1050 GB - Installation
folder
n
120 GB - /var/lib
n
20 GB - "/"
n
250 MB - /etc
600 GB, distributed as
follows:
n
450 GB - Installation
folder
n
120 GB - /var/lib folder
n
20 GB - "/" folder
n
250 MB - /etc folder
450 GB on each worker
node, distributed as
follows:
n
270 GB - Installation
folder
n
120 GB - /var/lib folder
n
20 GB - "/" folder
n
250 MB - /etc folder
2.2.2 Installation Prerequisites for SANnav Management Portal
SANnav Management Portal has additional prerequisites that must be met before you unzip the installation files.
n
Meet all system and server requirements.
n
Gather the following information:
– SANnav Management Portal server IP address.
– Ethernet network interface card (NIC). If multiple NICs are present, you must know on which NIC the SAN
management traffic should run.
n
You must log in as the root user, or a user with root privilege.
n
Operating system checks:
– Ensure that the entire physical server (boot, log, and data) runs on a single partition.
– Ensure that the operating system can be loaded through a bootable disk or through a PIXe server.
– Ensure that the lsof and nslookup packages are installed on the operating system machine.
n
"umask" for the root user must be set to 0022.
Enter the following command to set the umask:
umask 0022
NOTE
You must set the umask before you unzip the installation files. If you extracted the installation files before you
set the umask, you must delete the installation folder, run umask 0022, and then unzip the files again.
n
Ensure that the ulimit is set correctly.
To set the ulimit, edit the /etc/security/limits.conf file and add the following limit at the end of the file:
elasticsearch - nofile 65536
n
Ensure that the following ports are available / free:
– Port 22
– Port 80
Port 22 must be available to use the internal firmware repository. If port 22 is not available, you must use an external
FTP, SCP, or SFTP server for firmware download functionality.
Port 80 must be available; otherwise, installation fails. After installation, port 80 must continue to be available all the
time; otherwise, you cannot start (or restart) SANnav Management Portal.
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
18
If your network utilizes a firewall, there may be other ports that must be open. See the Firewall Requirements section
for details.
n
Uninstall docker, if already installed.
n
SANnav Management Portal is expected to be installed and run on a dedicated host; if any other application is
installed, uninstall it before starting the SANnav Management Portal installation.
n
Commands:
– Ensure that the "hostname -i" command resolves to a valid IP address.
– The nslookup command must be successful for the host name of the physical host and VM.
NOTE
Use the latest generation processors for better SANnav performance.
2.2.3 Installing the Application for Single-Node Deployment
Complete these steps to download and install SANnav Management Portal on the server.
Before unzipping the installation file, be sure to review and comply with the system and server requirements and the
installation prerequisites listed in the following sections:
n
System and Server Requirements for SANnav Management Portal
n
Installation Prerequisites for SANnav Management Portal
NOTE
If the scripts fail during the installation or startup, uninstall the application and then reinstall it. Do not try to fix
the issue and re-run the install-single-server.sh without first uninstalling the application.
Download and copy the SANnav Management Portal software package to the server. The package contains the SANnav
Management Portal tarball.
1. Download the SANnav Management Portal tarball ( for example, sannav_portal_1.1.1-distribution.tar.gz) to the folder
where you want to install the application.
NOTE
Do not create the SANnav Management Portal installation folder with a space in the name; otherwise,
installation will fail.
2. Untar the .gz file to extract the file to the current location.
tar -xvzf sannav_portal_1.1.1-distribution.tar.gz
The following is sample output.
[root@RHEL7-10-100 home]# tar -xvzf sannav_portal_1.1.1-distribution.tar.gz
Portal_1.1.1_rc_bld42/jre/
Portal_1.1.1_rc_bld42/jre/lib/
(output truncated)
(output truncated)
Portal_1.1.1_rc_bld42/conf/EULA/BRCD/license.html
Portal_1.1.1_rc_bld42/conf/EULA/license.html
[root@RHEL7-10-100 home]#
3. Go to the <install_home>/bin folder.
[root@RHEL7-10-100 home]# cd Portal_1.1.1_rc_bld42/bin
4. Run the install-single-node-server.sh script to install SANnav Management Portal.
[root@RHEL7-10-100 bin]# ./install-single-node-server.sh
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
19
In this stage, the installation script runs a pre-install requirements test. If any test fails, the installation exits with error
messages. You must fix the reported issues, uninstall the application, and repeat from step 1. After the diagnostics pass,
installation of SANnav Management Portal software continues. On successful installation of the software, the SANnav
Management Portal server starts up. The startup may take up to 20 minutes.
The following is a sample result of ./install-single-node-server.sh command execution.
[root@RHEL7-10-100 bin]# sh install-single-node-server.sh
Disk space available in /install_home/Portal_1.1.1_rc_bld42: 642 GB
Disk space available in /var/lib/: 642 GB
Disk space available in /: 642 GB
Current memory: 117 GB
UMASK set to: 0022
Number of CPU: 40
Host name to IP resolution: 00.000.00.00
Port 80 is free.
Number of CPU sockets available: 20
Operating System: Red Hat Enterprise Linux Server release 7.4 (Maipo)
NSLOOKUP of 00.000.00.00 resolved successfully
CPU Speed: 2592 MHz
BROCADE END USER LICENSE AGREEMENT
(output truncated)
(output truncated)
Successfully installed server. Press Enter to continue with server startup.
IP Address of the Manager is 00.000.00.00
Total Number of nodes in swarm: 1
Time Zone is America/Los_Angeles
MAC Address of the manager node is: 00:0c:00:00:b0:00
# Reading property from /install_home/Portal_1.1.1_rc_bld42/conf/version.properties
# Build Label is sannav1.1.1
Installing on 96 GB and above VM
Number of worker nodes configured are 0 and worker nodes are
There is only one node in cluster with zero worker nodes..Starting single node SWARM
cluster installation
Ignoring unsupported options: ulimits
Creating service dcm_1_1_0_externalapi-middleware
Creating service dcm_1_1_0_ignite-grid-object-manager-node
(output truncated)
(output truncated)
Successfully installed and started the server. Check server status by running /install_home/
Portal_1.1.1_rc_bld42/bin/diag/check-server-status.sh. Startup can take upto 20 Minutes.
After the server has started, launch the client using http://00.000.00.00
2.2.4 Installing the Application for Multi-Node Deployment
Complete these steps to download and install SANnav Management Portal on the server in a multi-node deployment.
Before unzipping the installation file, be sure to review and comply with the system and server requirements and the
installation prerequisites listed in the following sections:
SANnav-111-UG101 User Guide
Brocade SANnav Management Portal and Global View User Guide, 1.1.1
SANnav-111-UG101
20
/