WireGauge

 

 

 

1. Introduction

WireGauge is a tool to collect information from a NetApp controller and evaluate the nature of the cabling to the disk shelves. 

WireGauge works by connecting to a NetApp controller via a network connection or serial port.  It will run a few commands necessary for determining the storage hardware configuration.  The output from these commands will be parsed and a representation of the storage will be displayed to the user. 

The storage representation will show a hierarchial model of each "stack" of disk shelves, the disk shelves within that stack, and the disks in each shelf.  For each item, WireGauge will display the multipath state of the object. 

You can learn about how to run WireGauge here. 

 

Support for WireGauge can be found here. 

2. Help Topics

2.1 How to run WireGauge

Wiregauge (for the Windows platform) will come in a zip file.  The zip file will contain a number of files.  The WireGauge executable is WireGauge.exe.  You can run this by double clicking on the WireGauge executable icon.  It is usually safe to ignore and of the other files in the distribution. 

The WireGauge User Interface (pictured below) has 3 main components.  The left hand side shows the logs captured by WireGauge.  The top right section allows the user to input the connectivity to the controller (specifying the hostname, username, password, and serial port to use).  The bottom right section is where the representation of the disk shelves will be displayed. 

 

There are two primary modes of collecting data necessary for determining the nature of the wiring between the controllers and disks.  The first method is via a network connection.  The other is to use a USB-to-Serial adapter and connect to the console (serial) port on the controller.  If the network option is chosen, you can connect to the same network the controller is on, or setup a crossover connection between your computer and the controller.  If the serial option is chosen, WireGauge will run a small number of commands necessary.  On very large systems, this may take up to 5 minutes to complete.

This picture shows the User Interface when the Network option is selected. 

This picture shows the User Interface when the Serial option is selected.

 

Serial Connection Instructions


Network Connection Instructions

2.2 Data Capture via Serial Port

Serial Connection Instructions

  1. First choose the data collection method.  Click on the Serial radio button. 


  2. Enter the hostname of the controller in the Hostname field.  This must match the hostname of the controller exactly.  This is necessary so that WireGauge can detect when it sees the command prompt (and then will know it's ok to issue the next command). 
  3. Select the COM (serial) port your computer is connect to the controller through.  WireGauge will automatically detect all COM ports available on your computer at application startup.  If you are using a USB to serial adapter, make sure this is plugged in prior to starting WireGauge.  WireGauge will detect COM ports from COM1 to COM32. 


  4. Enter a username for WireGauge to login with.  This user must possess the ability to run 'sysconfig' and 'storage' commands. 
  5. Enter the password for the user entered in step 3.
  6. If you are running WireGauge as part of a new system installation, place the Sales Order number for the system in the Sales Order field.  This is optional when the system is not being installed.
  7. You can begin collecting the information from the controller by pushing the Collect Data button. 


  8. You should notice that the status bar will now read "Collecting Information...".  This may take several minutes depending on the number of disks connected to the system.  It is not uncommon for very large configurations to take up to 10 minutes.
  9. When WireGauge is launched, a debugging console window is also opened.  This will give you more information about what is going on with the application.  When WireGauge is collecting information, you will see all of the output in this window.  This window may also give you some insight into any issues WireGauge may be having.




  10. When you're done, go to the Analzing Results section.

2.3 Data Capture via Network

Network Connection Instructions

  1. First choose the data collection method.  Click on the Network radio button. 


  2. Enter the IP address of the controller in the Hostname or IP Address  field.  Note: You can use a hostname here, but only if the computer can resolve this name to an IP address.  It is recommended that you use an IP address to avoid any issues. 
  3. Enter a username for WireGauge to login with.  This user must possess the ability to run 'sysconfig' and 'storage' commands. 
  4. Enter the password for the user entered in step 3.
  5. If you are running WireGauge as part of a new system installation, place the Sales Order number for the system in the Sales Order field.  This is optional when the system is not being installed.
  6. You can begin collecting the information from the controller by pushing the Collect Data button. 


  7. You should notice that the status bar will now read "Collecting Information...".  This is usually a fairly quick process.  Even large configurations should finish in under 1 minute. 
  8. When WireGauge is launched, a debugging console window is also opened.  This will give you more information about what is going on with the application.  When WireGauge is collecting information, you will see all of the output in this window.  This window may also give you some insight into any issues WireGauge may be having.

2.4 Analyzing Results

Data Capture Complete and Analysis

  1. Once the data capture is complete, the results will be displayed in the lower right section of the interface. 


  2. The Disk Stacks can be expanded by clicking on the plus (+) sign next to the stack.  This will expand the stack to show all of the disk shelves in that stack.  Similarly, each shelf can be expanded to show all of the disks within the disk shelf.
  3. The status and any notes about each object will appear in the far right column of the results display.  Depending on the nature of the problem, this display should pinpoint any cabling issues with the controller.

2.5 What is a stack?

A disk stack is a group of up to 6 disk shelves connected to a NetApp controller.  This used to be synonymous with the term "loop", but since a stack of disks can belong to multiple "loops", the term loop is ambiguous. 

2.6 Multipath States

There are several multipath states for a disk, disk shelf, or shelf stack. 

 MutiPath State  Description
 SP  Single Path
 MP  Multi Path
 PP  Partial Path

A multipath state can mean different things to a shelf stack, disk shelf, or individual disk.

Stack
Single Path -- A single path stack has only one connection from a controller (or each controller in a cluster). 
Multi Path -- A shelf stack with a properly configured for MPHA. 
Partial Path -- A shelf stack where one or more disk shelves in the stack are not properly multipathed.  This can be due to a bad cable, improper cabling, or a bad shelf module.  This is a very bad situation and should be rectified immediately.

Shelf
Single Path -- A disk shelf with only one connection from a controller. 
Multi Path -- A disk shelf with two connections from a controller via the A and B modules.
Partial Path -- A disk shelf where some disks have multiple paths and others only have a single path.  This usually indicates there is a problem with the disk drive. 

Disk
Single Path -- A disk where either the primary port or secondary port is connected to a controller, but not both. 
Multi Path -- A disk where both the primary port and secondary port are connected to a controller.
Same Path -- A disk where both primary and secondary ports are connected to a controller via the same shelf module (A or B).  This usually indicates a wiring problem within the stack. 

2.7 How to submit WireGauge Logs to NetApp

WireGauge creates an XML file that contains information about the disk shelf wiring configuration of the controller.  This information is useful to NetApp Tech Support Center.  When you launch WireGauge for the first time, it will prompt you to "opt-in" for sending these log files to NetApp.  If you opt-in, these log files will be sent automatically if you are connected to the Internet.  This upload process will happen at the time WireGauge is launched, or immediately after you have captured information from the NetApp controller.

2.8 How to import an AutoSupport message (file)?

WireGauge is capable of reading an AutoSupport message that you have saved in a file.. 

  1. Click on the File menu.  Select Load ASUP from File from the menu.


  2. Find the file you want to parse from the file menu.  Click Open.



  3. Be patient.  It will take a few seconds to read through the Autosupport message.  Once complete, WireGauge will show you the results.

 

2.9 How to import an AutoSupport message (ASUP-DW)?

WireGauge is capable of pulling AutoSupport messages directly from the AutoSupport search engine.  This feature is available only to users connected inside the NetApp intranet.  This feature is not availble to partners or customers (sorry!).  This feature is disabled if WireGauge cannot reach the Autosupport database server.

  1. Find the Autosupport message you want to see the wiring configuration in the Autosupport database.  (http://asup-search.corp.netapp.com/cgi-bin/liteHome/netappLite.cgi).  You will need the Autosupport ID from the search engine.  This ID usually has the format "AE2009xxxxxxxxxx"


  2. Click on the File menu, and select Get ASUP button, or type Alt + A on your keyboard. 


  3. Enter the AutoSupport ID in the dialog box. 


  4. The necessary sections of the AutoSupport message are downloaded and parsed.  The result is displayed in the bottom right section of the user interface.

2.10 How do I get support for WireGauge?

If you are a NetApp employee or Partner, you can get support for WireGauge from here.  Open a support ticket at this site and your issue will be handled as quickly as possible.  Please include information such as: