Home » HP Manuals » Storage Devices » HP Cisco MDS 9020 » Manual Viewer

HP Cisco MDS 9020 Cisco MDS 9000 Family Fabric Manager Configuration Guide - R - Page 1406

getSwitchByKey, Return Value, Error, Parameters

Add to My Manuals
Save this manual to your list of manuals

Page 1406 highlights

Methods Chapter 69 Fabric Manager Web Services Send documentation comments to [email protected] Return Value List of all fabrics associated with the specified fabric key. Error Error Code: 300- General SAN Service exception. getSwitchByKey Returns the switch associated with the specified switch key object. Parameters key-Key of the fabric. Return Value Switch associated with the specified switch key. Error Error Code: 300- General SAN Service exception. Error code: 201-Invalid argument in Web Service exception. getSwitchIPByName Returns the IP address associated with the specified system name or switch name. Parameters sysname-Name of the system or switch. Return Value IP address associated with the specified system name. Error Error Code: 300- General SAN Service exception. Error code: 201-Invalid argument in Web Service exception. getSwitchIPByKey Returns the IP address of the switch associated with the specified WwnKey object. Parameters key-WWN Key object. Return Value IP address associated with the specifiedWwnKey object. 69-6 Cisco MDS 9000 Family Fabric Manager Configuration Guide OL-17256-03, Cisco MDS NX-OS Release 4.x

Section	Page
Cisco MDS 9000 Family Fabric Manager Configuration Guide, Release 4.x	1
Contents	3
New and Changed Information	57
Preface	61
Part 1	71
Getting Started	71
Product Overview	73
Hardware Overview	73
Cisco MDS 9500 Series Multilayer Directors	74
Cisco MDS 9200 Series Fabric Switches	75
Cisco MDS 9216i Multiprotocol Fabric Switch	75
Cisco MDS 9222i Multilayer Fabric Switch	75
Cisco MDS 9100 Series Fixed Configuration Fabric Switches	76
Cisco NX-OS Software Configuration	76
Tools for Software Configuration	77
CLI	77
Cisco MDS 9000 Fabric Manager	77
Software Configuration Overview	78
Basic Configuration	78
Advanced Configuration	79
Switch Configuration	79
Fabric Configuration	79
Security	79
IP Services	80
Intelligent Storage Services	80
Network and Switch Monitoring	80
Traffic Management	80
Installing Cisco MDS NX-OS and Fabric Manager	81
Starting a Switch in the Cisco MDS 9000 Family	81
Initial Setup Routine	82
Preparing to Configure the Switch	82
Default Login	83
Setup Options	83
Assigning Setup Information	84
Configuring Out-of-Band Management	84
Configuring In-Band Management	89
Using the setup Command	92
Accessing the Switch	92
Where Do You Go Next?	93
About Cisco Fabric Manager	93
Fabric Manager Server	94
Fabric Manager Client	94
Fabric Manager Server Proxy Services	94
Device Manager	95
Performance Manager	95
Fabric Manager Web Server	95
Cisco MDS 9000 Switch Management	95
Storage Management Solutions Architecture	96
In-Band Management and Out-of-Band Management	97
mgmt0	97
IPFC	97
Installing the Management Software	98
Before You Install	98
Supported Software	99
Java Database Connectivity	99
Minimum Hardware Requirements	100
Upgrading Fabric Manager in Cisco SAN-OS Releases Prior to 3.1(2b)	100
Upgrading Fabric Manager in Cisco SAN-OS Releases 3.1(2b) and Later to 3.2(1)	100
Installing the Database	100
Directory Structure	101
Installing Oracle	102
Increasing UDP Buffer Size	103
Database Backup and Restore-PostgresSQL	103
Backup	103
Restore	104
Importing PM Statitics Data to Fabric Manager	104
Installing Fabric Manager	104
Installing Device Manager	114
Creating FM/DM Shortcut Manually	116
Upgrading the Management Software	118
Upgrading Fabric Manager Server and Fabric Manager Standalone Version Using the Fabric Manager Update Installer	119
Integrating Cisco Fabric Manager with Other Management Tools	120
Running Fabric Manager Behind a Firewall	120
Uninstalling the Management Software	123
Fabric Manager Server	125
Fabric Manager Server Overview	125
Fabric Manager Server Features	125
Installing and Configuring Fabric Manager Server	126
Installing Fabric Manager Server	126
Unlicensed Versus Licensed Fabric Manager Server	127
Verifying Performance Manager Collections	127
Managing a Fabric Manager Server Fabric	127
Selecting a Fabric to Manage Continuously	127
Fabric Manager Server Properties File	128
Modifying Fabric Manager Server	129
Adding or Removing Fabric Manager Server Users	130
Changing the Fabric Manager Server User Name and Password	131
Changing the Polling Period and Fabric Rediscovery Time	131
Using Device Aliases or FC Aliases	131
Authentication in Fabric Manager	133
Fabric Manager Authentication Overview	133
Best Practices for Discovering a Fabric	135
Setting Up Discovery for a Fabric	135
Performance Manager Authentication	136
Fabric Manager Web Server Authentication	136
Fabric Manager Client	139
About Fabric Manager Client	139
Fabric Manager Advanced Mode	140
Launching Fabric Manager Client in Cisco SAN-OS Release 3.2(1) and Later	140
Fabric Manager Client Quick Tour: Server Admin Perspective	145
Fabric Manager Main Window	145
Menu Bar	147
Tool Bar	147
Logical Domains Pane	147
Physical Attributes Pane	147
Information Pane	148
Fabric Pane	149
Fabric Manager Client Quick Tour: Admin Perspective	150
Menu Bar	151
File	151
View	152
Zone	152
Tools	153
Performance	155
Server	155
Help	155
Toolbar	155
Logical Domains Pane	157
Filtering	158
Physical Attributes Pane	158
Context Menu for Tables	158
Switch Options	158
ISL Options	159
End Device Options	160
Information Pane	161
Detachable Tables	162
Fabric Pane	162
Context Menus	164
Saving the Map	164
Purging Down Elements	165
Multiple Fabric Display	165
Filtering by Groups	166
Status Bar	168
Setting Fabric Manager Preferences	168
Network Fabric Discovery	170
Modifying the Device Grouping	170
Using Alias Names as Enclosures	171
Controlling Administrator Access with Users and Roles	172
Using Fabric Manager Wizards	172
Fabric Manager Troubleshooting Tools	173
Device Manager	175
Device Manager Overview	175
Device Manager Features	175
Launching Device Manager	176
Using Device Manager	176
Menu Bar	177
Toolbar Icons	178
Dialog Boxes	179
Tabs	179
Legend	179
Supervisor and Switching Modules	181
Context Menus	181
Setting Device Manager Preferences	182
Fabric Manager Web Client	183
Fabric Manager Web Client Overview	183
Navigating Fabric Manager Web Client	184
Installing Fabric Manager Web Client	185
Using Fabric Manager Web Client with SSL	187
Launching Fabric Manager Web Client	189
Health	191
Viewing Summary Information	191
Viewing Fabric Information	192
Viewing Syslog Information	193
Viewing Analysis Reports	194
Performance	195
Viewing Performance Summary Information	196
Performance Detail Summary Report	197
Viewing Performance Information for End Devices	198
Viewing Performance Information for ISLs	199
Viewing Performance Information for NPV Links	203
Viewing Performance Information for Flows	204
Viewing Performance Information for GigE Ports	205
Viewing Other Statistics	205
Viewing Detailed Traffic Information	206
Viewing Predicted Future Performance	207
Using the Default Values	207
Using Your Own Values	208
Viewing Switch Bandwidth	209
Inventory	210
Viewing Summary Inventory Information	210
Viewing Detailed Summary Inventory Information	211
Viewing Detailed Information for VSANs	211
Viewing Detailed Information for Switches	212
Viewing License Information	213
Viewing Detailed Information for Modules	214
Viewing Detailed Information for End Devices	215
Viewing Detailed Information for ISLs	216
Viewing Detailed Information for NPV Links	217
Viewing Detailed Information for Zones	218
Reports	219
Creating a Custom Report Template	219
Viewing Custom Reports by Template	221
Viewing Custom Reports by Users	221
Generating Custom Reports by Template	222
Modifying a Custom Report Template	223
Deleting Custom Reports	224
Viewing Scheduled Jobs by Report Template	225
Modifying Scheduled Jobs	225
Admin	226
Recovering a Web Server Password	227
Starting, Restarting, and Stopping Services	227
Adding, Editing, and Removing Managed Fabrics	228
Viewing Trap and Syslog Registration Information	230
Configuring Forwarding of Notifications for Events	231
Viewing and Disconnecting Clients	232
Configuring Fabric Manager Server Preferences	233
Adding and Removing Communities	233
Configuring AAA Information	235
Adding and Removing Users	235
Adding and Removing Roles	236
Creating Performance Collections	238
Configuring Other Statistics	239
Configuring Collection Thresholds	241
Importing the RRD Statistics Index	242
Configuring the RRD Database	242
Viewing Log Information	244
Downloading Fabric Manager Client	244
Performance Manager	245
Performance Manager Architecture	245
Data Interpolation	246
Data Collection	246
Using Performance Thresholds	246
Flow Setup Wizards	247
Creating a Flow Using Flow Configuration Wizard	247
Flow Statistics Configuration	250
About Flow Statistics	250
Cisco Traffic Analyzer	251
Understanding SPAN	251
Using Cisco Traffic Analyzer with Performance Manager	252
Understanding the PAA-2	252
Understanding Cisco Traffic Analyzer	253
Installing Cisco Traffic Analyzer	253
Accessing Traffic Analyzer from Fabric Manager Web Server	255
Part 2	257
Installation and Switch Management	257
Obtaining and Installing Licenses	259
Licensing Terminology	259
Licensing Model	260
Licensing High Availability	266
Options to Install a License	266
Obtaining a Factory-Installed License	267
Performing a Manual Installation	267
Obtaining the License Key File	267
Installing the License Key File	268
Installing Licenses Using Fabric Manager License Wizard	269
Installing or Updating Licenses Using Device Manager	270
Identifying License Features in Use	271
Uninstalling Licenses	272
Updating Licenses	272
Grace Period Alerts	273
License Transfers Between Switches	274
Displaying License Information	274
Viewing License Information in Fabric Manager	274
Viewing License Information in Device Manager	274
Viewing Licenses Using Fabric Manager Web Server	275
Fabric Manager Server Licensing	275
On-Demand Port Activation Licensing	277
About On-Demand Port Activation Licensing	277
Port-Naming Conventions	278
Port Licensing	278
License Status Definitions	279
Configuring Port Activation Licenses	280
Checking the Status of Licenses	280
Making a Port Eligible for a License	281
Acquiring a License for a Port	282
Initial Configuration	285
Assigning a Switch Name	285
Verifying the Module Status	286
Configuring Date, Time, and Time Zone	287
NTP Configuration	288
About NTP	288
NTP Configuration Guidelines	289
Configuring NTP	290
Editing an NTP Server or Peer Configuration	290
Deleting an NTP Server or Peer	291
NTP CFS Distribution	292
Configuring NTP with CFS	292
Committing NTP Configuration Changes	293
Discarding NTP Configuration Changes	293
Releasing Fabric Session Lock	293
Database Merge Guidelines	294
Management Interface Configuration	294
Default Gateway Configuration	294
Telnet Server Connection	295
Disabling a Telnet Connection	295
Configuring CDP	296
Using the CFS Infrastructure	299
About CFS	299
Cisco MDS NX-OS Features Using CFS	300
CFS Features	300
CFS Protocol	301
CFS Distribution Scopes	301
CFS Distribution Modes	302
Uncoordinated Distribution	302
Coordinated Distribution	302
Unrestricted Uncoordinated Distributions	302
Disabling CFS Distribution on a Switch	302
CFS Application Requirements	303
Enabling CFS for an Application	303
Locking the Fabric	304
Committing Changes	305
Discarding Changes	306
Saving the Configuration	306
Clearing a Locked Session	306
CFS Merge Support	307
Displaying CFS Configuration Information	307
CFS Distribution over IP	308
Configuring Static IP Peers for CFS over IP	309
Adding Peers to List	310
Removing an NPV Device from the Peer List	312
CFS Regions	314
About CFS Regions	314
Managing CFS Regions Using Fabric Manager	315
Creating CFS Regions	315
Assigning Features to CFS Regions	315
Moving a Feature to a Different Region	316
Removing a Feature from a Region	317
Deleting CFS Regions	317
CFS Example Using Fabric Manager	318
CFS Example Using Device Manager	321
Default Settings	321
Configuring FlexAttach Virtual pWWN	323
About FlexAttach Virtual pWWN	323
FlexAttach Virtual pWWN Guidelines and Requirements	324
Configuring FlexAttach Virtual pWWN	324
Enabling FlexAttach Virtual pWWN	324
Automatically Enabling FlexAttach Virtual pWWN	324
Launching FlexAttach in Fabric Manager	325
Manually Enabling FlexAttach Virtual pWWN	326
Mapping pWWN to Virtual pWWN	328
Debugging FlexAttach Virtual pWWN	330
Security Settings for FlexAttach Virtual pWWN	330
FlexAttach Virtual pWWN CFS Distribution	331
Using the Server Admin FlexAttach Wizards	331
Pre-Configuring FlexAttach for a New Server	331
Pre-Configuring FlexAttach for All the Ports	332
Pre-Configuring FlexAttach for Each Port Individually	334
Moving a Server to Another Port or Switch	337
Replacing a Server with Another Server	340
Replacing a Server on the Same Port	341
Replacing the Server to a Different Port on the Same Switch	343
Replacing with a Server on a Different Switch	344
Difference Between San Device Virtualization and FlexAttach Port Virtualization	345
Software Images	347
About Software Images	347
Dependent Factors for Software Installation	347
Selecting the Correct Software Images for Cisco MDS 9100 Series Switches	348
Selecting the Correct Software Images for Cisco MDS 9200 Series Switches	348
Selecting the Correct Software Images for Cisco MDS 9500 Family Switches	348
Essential Upgrade Prerequisites	349
Software Upgrade Methods	351
Determining Software Compatibility	351
Automated Upgrades	352
Benefits of Using the Software Install Wizard	352
Recognizing Failure Cases	353
Using the Software Install Wizard	354
Upgrading Services Modules	358
Nondisruptive Upgrades on Fabric and Modular Switches	359
Preparing for a Nondisruptive Upgrade on Fabric and Modular Switches	359
Performing a Nondisruptive Upgrade on a Fabric Switch	360
Maintaining Supervisor Modules	360
Replacing Supervisor Modules	361
Migrating from Supervisor-1 Modules to Supervisor-2 Modules	361
Standby Supervisor Module Boot Variable Version	361
Standby Supervisor Module Bootflash Memory	362
Standby Supervisor Module Boot Alert	362
Installing Generation 2 Modules in Generation 1 Chassis	362
Replacing Modules	363
Default Settings	363
Managing Configuration Files	365
About Flash Devices	365
Internal bootflash:	366
Formatting Flash Devices and File Systems	366
Using the File System	366
Flash Files	367
Creating a Directory	367
Deleting an Existing File or Directory	368
Copying Files	369
Performing Other File Manipulation Tasks	371
Working with Configuration Files	371
Downloading Configuration Files to the Switch	371
Saving the Configuration	372
Saving the Running Configuration	372
Saving Startup Configurations in the Fabric	373
Backing Up the Current Configuration	373
Configuring High Availability	375
About High Availability	375
Switchover Mechanisms	376
HA Switchover Characteristics	376
Initiating a Switchover	376
Switchover Guidelines	377
Process Restartability	377
Synchronizing Supervisor Modules	377
Managing System Hardware	381
Displaying Switch Hardware Inventory	381
Running the CompactFlash Report	382
Displaying the Switch Serial Number	383
Displaying Power Usage Information	383
Power Supply Configuration Modes	384
Power Supply Configuration Guidelines	385
About Crossbar Management	387
Operational Considerations When Removing Crossbars	389
Gracefully Shutting Down a Crossbar	389
Backward Compatibility for Generation 1 Modules in Cisco MDS 9513 Directors	390
About Module Temperature	391
Displaying Module Temperature	391
About Fan Modules	392
Default Settings	393
Managing Modules	395
About Modules	395
Supervisor Modules	396
Switching Modules	397
Services Modules	397
Verifying the Status of a Module	397
Obtaining Supervisor Module Statistics	398
Checking the State of a Module	398
Reloading Modules	399
Reloading a Switch	400
Power Cycling Modules	400
Preserving the Module Configuration	401
Powering Off Switching Modules	402
Identifying Module LEDs	403
Managing SSMs and Supervisor Modules	407
Considerations for Replacing SSMs and Supervisor Modules	407
Default Settings	407
Part 3	409
Switch Configuration	409
Configuring Interfaces	411
Common Interface Configuration	411
Fibre Channel Interfaces	412
Generation 1 Interfaces Configuration Guidelines	412
About Interface Modes	413
E Port	414
F Port	415
FL Port	415
NP Ports	415
TL Port	415
TE Port	416
TF Port	416
TNP Port	416
SD Port	416
ST Port	416
Fx Port	417
B Port	417
Auto Mode	417
About Interface States	417
Administrative States	417
Operational States	418
Reason Codes	418
Graceful Shutdown	421
Setting the Interface Administrative State	421
Configuring Interface Modes	422
Configuring Administrative Speeds	422
Autosensing	423
Specifying a Port Owner	423
Configuring Port Guard	426
About Interface Descriptions	428
About Frame Encapsulation	428
About Receive Data Field Size	428
Configuring Receive Data Field Size	428
Identifying the Beacon LEDs	429
About Speed LEDs	429
About Beacon Mode	430
Configuring Beacon Mode	430
About Bit Error Thresholds	430
Switch Port Attribute Default Values	431
About SFP Transmitter Types	431
Displaying SFP Transmitter Types	432
About Gathering Interface Statistics	432
Gathering Interface Statistics	432
TL Ports for Private Loops	433
About TL Ports	433
Configuring TL Ports	434
About TL Port ALPA Caches	435
Buffer Credits	435
About Buffer-to-Buffer Credits	435
Configuring Buffer-to-Buffer Credits	436
About Performance Buffers	436
Configuring Performance Buffers	437
About Extended BB_credits	437
Extended BB_credits on Generation 1 Switching Modules	437
Extended BB_credits on Generation 2 and Generation 3 Switching Modules	438
Configuring Extended BB_credits	438
Management Interfaces	439
About Management Interfaces	439
Configuring Management Interfaces	439
VSAN Interfaces	440
About VSAN Interfaces	440
Creating VSAN Interfaces	440
Default Settings	441
Configuring N Port Virtualization	443
About NPV	443
NPV Mode	445
NP Ports	445
NP Links	445
Internal FLOGI Parameters	445
Default Port Numbers	447
NPV CFS Distribution over IP	447
NPV Traffic Management	447
Auto	447