FERRET V5.4

download FERRET V5.4

of 24

Transcript of FERRET V5.4

  • 8/19/2019 FERRET V5.4

    1/62

    B0860AZ

    Rev A

    August 30, 2012

     

    I/A Series® System

    FERRET V5.4

    (Windows® Platforms)

    and FERRET V4.5.3(UNIX® Platforms)User’s Guide

  • 8/19/2019 FERRET V5.4

    2/62

    Invensys, Foxboro, I/A Series, the Invensys logo, Tricon, Triconex, Trident and TriStation are trademarks ofInvensys plc, its subsidiaries, and affiliates. All other brand names may be trademarks of their respective owners.

    Copyright 2012 Invensys Systems, Inc. All rights reserved

    SOFTWARE LICENSE AND COPYRIGHT INFORMATION

    Before using the Invensys Systems, Inc. supplied software supported by this documentation, youshould read and understand the following information concerning copyrighted software.

    1. The license provisions in the software license for your system govern your obligationsand usage rights to the software described in this documentation. If any portion ofthose license provisions is violated, Invensys Systems, Inc. will no longer provide you with support services and assumes no further responsibilities for your system or itsoperation.

    2. All software issued by Invensys Systems, Inc. and copies of the software that you arespecifically permitted to make, are protected in accordance with Federal copyrightlaws. It is illegal to make copies of any software media provided to you byInvensys Systems, Inc. for any purpose other than those purposes mentioned in thesoftware license.

  • 8/19/2019 FERRET V5.4

    3/62

    iii

    Contents 

    Figures..................................................................................................................................... v 

    Tables.................................................................................................................................... vii

    Preface.................................................................................................................................... ix 

    Revision Information ............................................................................................................... ix 

    Reference Documents .............................................................................................................. ix 

    Glossary ................................................................................................................................... ix 

    1. Introduction...................................................................................................................... 1

    Pointing Devices ....................................................................................................................... 1

    Keyboard ................................................................................................................................... 2

    Selecting Functions and Menu Items ........................................................................................ 2

    2. Executing the 50 Series FERRET Software........................................................................ 3

    Starting FERRET ...................................................................................................................... 3

    50 Series FERRET Run-Types Screen ....................................................................................... 4

    50 Series Data Topology Screen ................................................................................................ 5

    50 Series Site Information Screen .............................................................................................. 6

    50 Series FERRET Complete Screen ......................................................................................... 7

    3. Executing the 70 Series FERRET Software........................................................................ 9

    I/A Series V8.5 Secured Stations ............................................................................................... 9

     ATS Stations in Extender Mode ................................................................................................ 9

    Starting 70 Series FERRET ..................................................................................................... 10

    Executing 70 Series FERRET .................................................................................................. 11

    Running FERRET on Problem Stations ................................................................................. 11

    Installing FERRET on a Problem Station ............................................................................... 12Merging Problem Station Data into a Single Site File ............................................................. 13

    Reviewing Results and Editing Parts List ................................................................................. 13

    4. 70 Series FERRET User Interface.................................................................................... 15

    Run Types Screen ................................................................................................................... 15

    Run Status Display .................................................................................................................. 18

  • 8/19/2019 FERRET V5.4

    4/62

    B0860AZ – Rev A Contents

    iv

    Site Info Screen ....................................................................................................................... 20

    Station Exclude Screen ............................................................................................................ 21

    User Defined SNMP Screen .................................................................................................... 22

    File Data / File Info / Paths Screens ........................................................................................ 24

    5. Command Line Parameters............................................................................................. 25

    6. FERRET Menus.............................................................................................................. 27

    File Menu ............................................................................................................................... 27

    Edit Menu .............................................................................................................................. 28

    View Menu ............................................................................................................................. 28

    7. Scheduled Runs (Unattended Execution) ........................................................................ 31

    Opening the Scheduled Run Dialog ........................................................................................ 31

    Creating a Scheduled Run ....................................................................................................... 33Editing a Scheduled Run ......................................................................................................... 34

    Scheduled Run Wizard - Dialog 1 ...................................................................................... 34Scheduled Run Wizard - Dialog 2 ...................................................................................... 36Scheduled Run Wizard - Dialog 3 ...................................................................................... 37

    Scheduled Run Output Files ................................................................................................... 38

    8. FERRET for Triconex Equipment................................................................................... 39

    9. Considerations ................................................................................................................ 41

    Site Equipment List ................................................................................................................ 41

    Network Equipment Calculations ........................................................................................... 41

    FBM and ECB Counts ............................................................................................................ 42

    FERRET Output with Installed Base Repository .................................................................... 42

    FERRET Output and www.BuyAutomation.com ................................................................... 42

    10. FERRET Software Subdirectory.................................................................................... 43

     Appendix A. FERRET Site Log ........................................................................................... 45

     Appendix B. NetMon Report .............................................................................................. 47

     Appendix C. DiagFist Report .............................................................................................. 49

     Appendix D. Site Equipment Report................................................................................... 51

  • 8/19/2019 FERRET V5.4

    5/62

    v

    Figures 

    2-1. 50 Series FERRET Start Screen ..................................................................................... 42-2. 50 Series Data Topology Screen .................................................................................... 5

    2-3. 50 Series Site Information Screen .................................................................................. 62-4. 50 Series FERRET Complete Screen ............................................................................. 73-1. ATS in Extender Mode Shown on the FERRET Station Exclude Screen .................... 103-2. 70 Series Run Types Screen ......................................................................................... 113-3. 70 Series Run Status Screen with Problem Stations ..................................................... 124-1. 70 Series User Interface - Run Type Screen ................................................................. 164-2. 70 Series User Interface - Run Status Screen ............................................................... 184-3. 70 Series User Interface - Site Information Screen ....................................................... 204-4. 70 Series User Interface - Station Exclude Screen ........................................................ 214-5. 70 Series User Interface - User-Defined SNMP Screen ................................................ 224-6. 70 Series User Interface - File Data/File Info/Paths Screens ......................................... 24

    6-1. FERRET Menus - File Menu ...................................................................................... 276-2. FERRET Menus - Edit Menu ..................................................................................... 286-3. FERRET Menus - View Menu .................................................................................... 287-1. Scheduled Runs - Schedule Run Dialog ...................................................................... 327-2. Scheduled Runs - New Scheduled Run Dialog ............................................................ 337-3. Scheduled Runs - Schedule Run Wizard Dialog 1 ....................................................... 347-4. Scheduled Runs - Schedule Run Wizard Dialog 2 ....................................................... 367-5. Scheduled Runs - Scheduled Run Wizard Dialog 3 ..................................................... 377-6. Scheduled Runs - Scheduled Run Sub-directory .......................................................... 38 A-1. FERRET Site Log ....................................................................................................... 45B-1. NetMon Report .......................................................................................................... 47

    C-1. DiagFist Report ........................................................................................................... 49D-1. Site Equipment Report ................................................................................................ 51

  • 8/19/2019 FERRET V5.4

    6/62

    B0860AZ – Rev A Figures

    vi

  • 8/19/2019 FERRET V5.4

    7/62

    vii

    Tables 

    2-1. 50 Series FERRET Run Types ...................................................................................... 42-2. 50 Series Data Topology Selections ............................................................................... 5

    2-3. 50 Series Site Information Selections ............................................................................. 64-1. 70 Series User Interface - Run Types ........................................................................... 164-2. Run Display Buttons ................................................................................................... 174-3. 70 Series User Interface - Run Status Indicators (Icons) .............................................. 194-4. 70 Series User Interface - Run Status Screen Columns ................................................ 194-5. 70 Series User Interface - Site Information .................................................................. 204-6. 70 Series User Interface - Station Exclude Spreadsheet Columns ................................. 214-7. 70 Series User Interface - User-Defined SNMP XMLTag Names and Attributes ........ 235-1. Command Line Parameters - ferret_gather.exe ............................................................ 255-2. Command Line Parameters - fes.exe ............................................................................ 266-1. File Menu ................................................................................................................... 27

    6-2. Edit Menu Options ..................................................................................................... 286-3. View Menu Options ................................................................................................... 297-1. Scheduled Runs - Schedule Run Options .................................................................... 327-2. Scheduled Runs - Schedule Run Wizard Dialog 1 ....................................................... 3510-1. 70 Series FERRET Subdirectory ................................................................................. 4310-2. 20/50/51 Series FERRET Subdirectory ....................................................................... 44

  • 8/19/2019 FERRET V5.4

    8/62

    B0860AZ – Rev A Tables

    viii

  • 8/19/2019 FERRET V5.4

    9/62

    ix

    Preface 

    This document is intended for use by Field Service Representatives. It provides specific informa-tion and procedures for configuring and running FERRET including collecting System Manage-

    ment Information, switch data via SNMP, and station information via I/A Series® configurationfiles. For FERRET installation details for 50 Series and 70 Series stations, refer to the FERRETInstallation Guide  (B0860RC).

    Revision InformationThis is the initial release of this document.

    Reference Documents

    In addition to the information presented herein, you should be familiar with the followingI/A Series documents:

    FERRET 5.3 Installation Guide  (B0860RC)

    The MESH Control Network Architecture Guide (B0700AZ)

    The MESH Control Network Operation, and Switch Installation and ConfigurationGuide (B0700CA)

    System Asset Viewer 2.0 I/A and Triconex Installation and User's Guide  

    The latest revisions are available through the Invensys Operations Management Global CustomerSupport Center at http://support.ips.invensys.com .

    GlossaryFERRET FERRET is an application that creates a site equipment list from an

    I/A Series system. The software is installed on a single workstation where it remotely connects to all other workstations at the site to: col-lect installed software, System Management information, inter-pro-cess connections between CPs and between CPs and Workstations.

    Installed BaseRepository 

    The Installed Base Repository is a database of all the Invensys sites where a FERRET collection has been performed. All Invensysemployees can access this data via the Global Customer Support web-

    site (http://support.ips.invensys.com ) or the System Asset Viewerapplication.

    System Asset Viewer System Asset Viewer is a separate application that accepts FERRETfiles and displays the data contained within. It can also upload anddownload FERRET data directly to the Installed Base Repository.

  • 8/19/2019 FERRET V5.4

    10/62

    B0860AZ – Rev A Preface

    x

  • 8/19/2019 FERRET V5.4

    11/62

    1

    1. Introduction

    This chapter serves as an introduction to FERRET and covers how to select basic functions andmenu items.

    FERRET is intended for use by Field Service Representatives. It provides for collecting the siteinformation data in a single FERRET file (called a DAT file). This single file can be used with theRemoteWatch server offering, uploaded to the Invensys Equipment Repository, or opened in theSystem Asset Viewer product.

    Separate versions of FERRET are offered for each supported operating system. The most currentversions of FERRET for each operating system are:

    FERRET v5.4 (the following Windows® platforms):

     Windows NT 4.0 SP3 and greater

     Windows 7 and Windows XP

     Windows Server 2008 and Windows Server 2003

    FERRET v4.5.3 (UNIX ® platforms).

    Once you have physically connected your system and loaded the appropriate software as definedby the commit diskette produced by the System Definition application, you can begin usingFERRET.

    The best way to become familiar with FERRET is to just sit down and use it. Use a pointingdevice (mouse or trackball) to make selections.

    NOTE

    The FERRET application is a collection-only tool. It cannot be used to modify any

    system parameters, update configurations, or clear alarms.

    Pointing DevicesFor 70 Series stations with FERRET software, the cursor is the primary means for making menuselections and for selecting FERRET functions or data fields. Cursor control is available through atouchscreen, a pointing device (mouse or trackball), or keyboard cursor control keys.

     A menu or function is selectable if it is highlighted, or when it highlights or frames as the mousemoves over it.

    In some functions, auxiliary keystrokes from an alphanumeric keyboard are necessary for imple-mentation. Two examples are:

    Entering Site Information

    Entering a second IP address for a station.

    The pointing device is used to navigate the tree structure to select various screens within FER-RET. Clicking on the plus (+) or minus (-) sign within the tree control will expand or collapse theselection.

  • 8/19/2019 FERRET V5.4

    12/62

    B0860AZ – Rev A 1. Introduction

    2

    KeyboardFor 50 Series stations with FERRET software, the only input method is the keyboard. This isbecause the 50 Series version of FERRET is a script running in a VT terminal window. Keyboardentries are limited to choosing menu items and entering site information data.

    Selecting Functions and Menu ItemsSome functions can be selected either by a pointing device or keyboard. When FERRET softwareis expecting input from a pointing device, this document uses Select .

     When FERRET software is expecting input from the keyboard, this document uses Press or Type.

  • 8/19/2019 FERRET V5.4

    13/62

    3

    2. Executing the 50 Series FERRETSoftware 

    This chapter describes executing FERRET software on a 50 Series workstation. See theFERRET Installation Guide (B0860RC) for instructions on installing FERRET.

    For sites with no Windows stations or when the Windows version cannot connect to a UNIXstation, you will have to run the UNIX ® version of FERRET.

    NOTE

     After FERRET completes the collection program, you need to import the com-pressed tar file created by the UNIX version into System Asset Viewer to completethe run.

    Starting FERRETExecuting the script FERRET starts the collection programs on the main station host. Upon com-pletion you are prompted to save the compressed tar file to a diskette. 50 Series processors formatthe diskette with a DOS format, while 20 Series processors need to have a DOS formatted dis-kette supplied.

    To start FERRET on a 50 Series Workstation, perform the following:

    NOTE

    If using VT100 mode, type su before running the script. If running from the cmd-tool, this is not necessary.

    1. Change the directory to the appropriate FERRET subdirectory:

    a. For 50/51 Series stations: cd/opt/fox/bin/remote/tools/FERRET

    b. For 20 Series stations: cd/usr/fox/bin/remote/tools/FERRET

    2. Execute the following script: FERRET

  • 8/19/2019 FERRET V5.4

    14/62

    B0860AZ – Rev A 2. Executing the 50 Series FERRET Software

    4

    50 Series FERRET Run-Types Screen After starting the script FERRET, you are prompted for the run type. You should run FERRETonce on the main host station. During its run, FERRET may be unable to connect to a station. Inthis scenario you should install FERRET on that problem station and press 2, which runs theoption Execute FERRET on this machine Local).

     

    Figure 2-1. 50 Series FERRET Start Screen

    Table 2-1. 50 Series FERRET Run Types

    Option Description

    Execute FERRET on entire System (All Hosts).Run this first.

    2 Execute FERRET on this machine (Local).Run this on missing stations.

    3 Exit and Quit without running FERRET.

  • 8/19/2019 FERRET V5.4

    15/62

    2. Executing the 50 Series FERRET Software B0860AZ – Rev A

    5

    50 Series Data Topology ScreenThe second screen allows you to collect Data Topology information using the som and rsom util-ities. This information can be used to create a data topology report in the Installed Based Viewer.

    NOTE

    som and rsom have been known to cause some 51B stations to reboot. Appropriate

    care should be taken when choosing this option.

    Figure 2-2. 50 Series Data Topology Screen

    Table 2-2. 50 Series Data Topology Selections

    Option Description Notes

    1 Collect Data Topology information. See previous note regardingsom and rsom.

    2 Skip collection.

    3 Exit and Quit.

  • 8/19/2019 FERRET V5.4

    16/62

    B0860AZ – Rev A 2. Executing the 50 Series FERRET Software

    6

    50 Series Site Information ScreenThe next screen will prompt you for the site information for this collection. This information isstored with the FERRET output files.

    Figure 2-3. 50 Series Site Information Screen

    Table 2-3. 50 Series Site Information Selections

    Field Description

    Site Name The name of this site. The name should be the same as the sitename in the Installed Based Repository.

    Site Location Location of the site, for example: Dallas, Texas.

    Process Unit Identification Name identifying Process Unit, for example: Boiler.

    Service Representative Name Name of FSR running FERRET.

    FoxWatch 3 Letter Code Three letter FoxWatch code, if one exists.

  • 8/19/2019 FERRET V5.4

    17/62

    2. Executing the 50 Series FERRET Software B0860AZ – Rev A

    7

    50 Series FERRET Complete Screen After FERRET completes you are prompted to provide a diskette to save the output files. Onceyou have saved the files, you need to use System Asset Viewer to see the final results of theFERRET collection. See the System Asset Viewer user’s guide for more information.

    Figure 2-4. 50 Series FERRET Complete Screen

  • 8/19/2019 FERRET V5.4

    18/62

    B0860AZ – Rev A 2. Executing the 50 Series FERRET Software

    8

  • 8/19/2019 FERRET V5.4

    19/62

    9

    3. Executing the 70 Series FERRETSoftware 

    This chapter describes how to start and execute FERRET on a 70 Series workstation.

    In order to execute 70 Series FERRET software successfully, you must be aware of the followingimportant information regarding:

    I/A Series V8.5 secured stations

     Address Translation Stations (ATS) in Extender Mode

    I/A Series V8.5 Secured StationsTo run FERRET on a secured station you have to first log into the station with a Domain

     Account in the Plant Maintenance domain group. This account will give FERRET enough privi-leges to collect the information it needs.

    From the secured station, FERRET can then connect to and collect data from the following sta-tions and nodes:

    Other I/A Series V8.5 secured stations

    I/A Series Standard and 8.x Legacy stations

    I/A Series V7.x and V6.x nodes connected via an ATS in LAN Interface (LI) mode.

    NOTE

     When running FERRET on I/A Series V8.5 standard stations or legacy stations,you should exclude any security enhanced stations from the collection. Otherwise,FERRET will attempt to connect and repeatedly fail causing the run to be substan-tially longer.

    NOTE

     When running FERRET on I/A Series V8.8 security enhanced stations, you mustnot be logged in with an account in the IAInstaller group. This group installs appli-cations only.

    ATS Stations in Extender ModeFERRET cannot collect data from legacy nodes (I/A Series V7.x or V6.x) connected via an ATSin Extender mode (also referred to as a bridge node). An ATS in this configuration does not routethe IP protocol, which is required by FERRET to connect to remote stations. In this scenario,FERRET attempts to use a 2nd LAN connection to bypass the ATS and access the legacy stations;it collects the data if the 2nd LAN connection is available.

  • 8/19/2019 FERRET V5.4

    20/62

    B0860AZ – Rev A 3. Executing the 70 Series FERRET Software

    10

    For I/A Series stations without a 2nd LAN connection, the data collection fails. You must thenrun FERRET on the legacy node(s) and merge the results.

    On the Station Exclude screen if you see any nodes with both an ATS and an LI, then that node isa bridge node for the site. You should enter the 2nd IP address for any station that has a 2ndEthernet card. See Figure 3-1.

    Figure 3-1. ATS in Extender Mode Shown on the FERRET Station Exclude Screen

    Starting 70 Series FERRETTo start FERRET from the Start menu, proceed as follows:

    Select Start > Programs > FERRET > FERRET for Windows.

    FERRET starts and the Run Types screen (Figure 3-2) appears. The Run Types screen is used todetermine what type of data is collected by FERRET. It allows you to start a FERRET run and setthe collection speed using the throttle. For a full description, see Chapter 4 “70 Series FERRETUser Interface”.

  • 8/19/2019 FERRET V5.4

    21/62

    3. Executing the 70 Series FERRET Software B0860AZ – Rev A

    11

    Figure 3-2. 70 Series Run Types Screen

    Executing 70 Series FERRETTo run FERRET to collect data for all stations:

    1. Choose your settings from the Run Types, Station Exclude, and Advanced screens.See Chapter 4 “70 Series FERRET User Interface” for more information.

    2. Start the run by clicking on the Start FERRET button on the “Run Types” screen. You can also click Start FERRET on the main toolbar. See Figure 3-1.

    Running FERRET on Problem Stations After the first run to collect data for All stations has completed, you should analyze the results. Any stations that appear with a Red Exclamation (!) are problem stations. A problem station isone from which FERRET could not collect data (usually, for connectivity reasons). You can see a

    list of the problem stations on the Run Status screen (Figure 3-3).Possible problems include: an ATS between the Host station and the problem station or the sta-tion may have an active firewall. For whatever reason, you need to install and run FERRET oneach problem station.

  • 8/19/2019 FERRET V5.4

    22/62

    B0860AZ – Rev A 3. Executing the 70 Series FERRET Software

    12

    Figure 3-3. 70 Series Run Status Screen with Problem Stations

    Installing FERRET on a Problem Station1. Install FERRET on the problem station. See the FERRET Installation Guide  

    (B0860RC) for instructions on installing FERRET.

    2. Start FERRET and perform a single station collection as follows:

    For 70 Series stations:

    a. On the problem station choose only that station Letterbug in the Station Excludescreen.

    b. Select the same options on the “Run Types” screen.

    c. Run FERRET and save the output.

    d. From the File menu choose Save FERRET file. The file should fit on a diskette.

    For 50 Series stations:

    a. Choose single station only when prompted.

    b. Run FERRET for just that station and collect the compressed tar file(LBUG_1.Z) it creates.

  • 8/19/2019 FERRET V5.4

    23/62

    3. Executing the 70 Series FERRET Software B0860AZ – Rev A

    13

    Merging Problem Station Data into a Single Site FileTo merge problem station data to a single file, proceed as follows:

    1. Place the collected FERRET file and/or UNIX tar files in the FERRET/gather sub-directory on the host station. (D:\opt\fox\bin\remote\tools\FERRET\gather )

    2. Choose File > Save FERRET file to create the final FERRET file. This action

    merges all the files in the /gather subdirectory into a single FERRET file.

    Reviewing Results and Editing Parts List After FERRET completes, review the parts list that was created. To do this, open the final FER-RET file in the System Asset Viewer application. See the System Asset Viewer 2.0 I/A and TriconexInstallation and User's Guide  for more information on editing parts lists.

  • 8/19/2019 FERRET V5.4

    24/62

    B0860AZ – Rev A 3. Executing the 70 Series FERRET Software

    14

  • 8/19/2019 FERRET V5.4

    25/62

    15

    4. 70 Series FERRET User Interface

    This chapter describes the various screens used by the FERRET user interface.

    The user interface for FERRET provides run options and better feedback when FERRET isunable to collect data from workstations. Use this feedback to run FERRET locally on the prob-lem stations and ensure the output is a complete picture of the site.

    Run Types ScreenThe Run Types screen is used to determine what type of data is collected by FERRET. It allowsyou to start a FERRET run and set the collection speed using the throttle. The Reset to FactorySettings button resets all selections in FERRET to their original state. A description of the com-ponents appears Table 4-1.

    NOTEData Topology collects OM data to determine IPC issues, such as ghost lists. This isnot required for a Site Equipment list.

  • 8/19/2019 FERRET V5.4

    26/62

    B0860AZ – Rev A 4. 70 Series FERRET User Interface

    16

    Figure 4-1. 70 Series User Interface - Run Type Screen

     Table 4-1. 70 Series User Interface - Run Types

    Type Description

    Standard Data Collects all standard data including everything from the File Data,File Info and Paths screen. It also collects the Add/Remove pro-grams list, the Windows Services list, and the current BIOS infor-mation.

    SysMgmt Data Uses frev or remv/remd to collect Equipment Information fromsystem management.

    SNMP Data from Switches Uses the Nutcracker SNMP utility to query the SNMP database on

    switches.Vendor Part Number Only Only collects one piece of data from each switch, the sysDecr.0

    OID. This allows FERRET to identify the Vendor part number andsubsequently the Invensys part number.

     Walk Entire Switch Performs a SNMP walk and collects the entire SNMP databasefrom the switch. This setting resets after each run of FERRET toVendor Part Number.Note: The SNMP database is very large and should only be col-lected when its information is needed.

  • 8/19/2019 FERRET V5.4

    27/62

    4. 70 Series FERRET User Interface B0860AZ – Rev A

    17

    User Defined Uses the xml settings from the User Defined SNMP screen whencollecting data.

    Data Topology Uses the som/rsom and ps utilities to collect information from thepoints database on CPs and workstations. This data can be used tocreate a Data Topology report in the Installed Base Viewer.

    Check Monitors This option performs a global find (GLOF) for each system moni-tor.

    User Defined Scripts Runs each selected script on the User Scripts screen. Any outputfrom these scripts is copied back to the host station.

    Recheck Missing Stations /Monitors

    Rechecks those stations that FERRET normally skips if not found with GLOF. Use this run type when bringing stations online.

    Continue Run Continues a previous run of FERRET. You are required to pick aFERRET file that contains the previous run.

    Check / Uncheck All Selects or clears all options.Throttle Slows the execution of FERRET.

    Table 4-2. Run Display Buttons

    Button Description

    Reset to Factory Settings Resets all settings in FERRET back to the Factory defaults.Note: To perform a minimal run which collects enough data to cre-ate an Equipment List, select Reset to Factory Settings on theRun Types screen. This action resets all selections on all screens to what is needed for a minimum run of FERRET.

    Passwords Changes the password for any stations that do not use the standardfox account and password.FERRET uses the standard fox account when connecting to Win-dows stations and root when connecting to UNIX stations. It alwaysuses gnomes as the password.Note: The changed passwords are not saved and are only used for thisinstance of FERRET.

    Start FERRET Starts FERRET and is the same as the Start FERRET button on thetoolbar.

    Cancel Stops FERRET once a collection has started.

    Table 4-1. 70 Series User Interface - Run Types

    Type Description

  • 8/19/2019 FERRET V5.4

    28/62

    B0860AZ – Rev A 4. 70 Series FERRET User Interface

    18

    Run Status DisplayThe Run Status screen displays the results from the last FERRET run. The top half contains allthe logs of each host as well as the main host. The bottom half contains a list of every station atthe site.

    NOTE

    Clicking on any of these stations shows the collection logs from the last run per-formed on that station, which is very useful when determining why a station wasnot collected.

    During a run, the station list (Figure 4-2) is updated with the current stations from which data isbeing collected. FERRET displays a status in the Station Status column of any station it is collect-ing from in the current run. As FERRET installs and remotely collects data, you see this columnupdate.

    Figure 4-2. 70 Series User Interface - Run Status Screen

  • 8/19/2019 FERRET V5.4

    29/62

    4. 70 Series FERRET User Interface B0860AZ – Rev A

    19

    Table 4-3. 70 Series User Interface - Run Status Indicators (Icons)

     Icons Description

     A green checkmark appears if FERRET successfully collected all the data forthat station.

      A red exclamation mark indicates FERRET found the station but was not ableto collect all the data for that station. This can happen if FERRET cannot con-nect to the station. You should run FERRET on that station choosing to collectdata from that station only.

      A yellow question mark indicates if the station was found in a configuration fileor System Management but FERRET was unable to locate the station viaGLOF. This might mean the station is off-line or that the configuration filesneeds to be updated. (Commit disk needs to be applied.)

      The station icon appears while FERRET is collecting its data.

    Table 4-4. 70 Series User Interface - Run Status Screen Columns

    Heading Description

    Letterbug List of all station and switch letterbugs at the site. The icon for each stationdenotes its status as described in Table 4-3.

    Desc Description of each station or node

    Last

    Collection

    Date and time of the last FERRET collection for each station

    Station Status Description of the collection status for each station

  • 8/19/2019 FERRET V5.4

    30/62

    B0860AZ – Rev A 4. 70 Series FERRET User Interface

    20

    Site Info ScreenThe Site Info screen contains information that identifies the site at which FERRET is being run.

    Figure 4-3. 70 Series User Interface - Site Information Screen

    Table 4-5. 70 Series User Interface - Site Information

    Field DescriptionRun InFormation

    Name Customer site name

    Location Physical location (example, Dallas, TX)

    Process Unit Site function (example, Boiler)

    Service Rep Name of the Field Service Representative running FERRET

    FoxWatch Code Three letter FoxWatch code, if one exists

    Optional Information

    Site ID Unique 32-character site ID retrieved from the GCS website. This ID is

    stored in the FERRET output file and can be used to identify the cus-tomer site run.

  • 8/19/2019 FERRET V5.4

    31/62

    4. 70 Series FERRET User Interface B0860AZ – Rev A

    21

    Station Exclude ScreenThe Station Exclude screen allows you to select the stations from which FERRET should collectdata. To stop FERRET from collecting from a station, simply uncheck the station. Stations can bedisplayed for the entire site or for an individual node by clicking on the node in the left view pane.

    Figure 4-4. 70 Series User Interface - Station Exclude Screen

    Table 4-6. 70 Series User Interface - Station Exclude Spreadsheet Columns

    Column Heading Description

    Letterbug List of all station and switch letterbugs at the site. The icon for each stationdenotes its status as described in Table 4-3.

    Desc Description of each station or node.

    Last Run Date and time of the last FERRET collection.

    Second IP Address Either an IP address for the station or its letterbug. If a second LAN is available,FERRET replaces the letterbug with its second IP address after the first run.The user can also enter the second IP address. It is recommended that all sta-tions with a second IP address are entered here.

    Station Status Run status for each station.

  • 8/19/2019 FERRET V5.4

    32/62

    B0860AZ – Rev A 4. 70 Series FERRET User Interface

    22

    User Defined SNMP ScreenThe User-Defined SNMP screen allows you to create custom collection xml scripts for FERRET.The format of the scripts is xml tags. The resultant xml is inserted into the ferret_gather.xmlfile in the D:\opt\fox\bin\remote\tools\ferret\data  directory.

    See Table 4-7 for information about XML tag names and attributes.

    Figure 4-5. 70 Series User Interface - User-Defined SNMP Screen

  • 8/19/2019 FERRET V5.4

    33/62

    4. 70 Series FERRET User Interface B0860AZ – Rev A

    23

    Table 4-7. 70 Series User Interface - User-Defined SNMP XMLTag Names and Attributes

    Tag Names   Description

      Perform a SNMP walk using oid1 or oid2 and store the results in/SNMP.txt in collected files for the switch.

      Perform a SNMP get using oid1 or oid2 and store the results in/SNMP.txt

      Perform a SNMP bulkget using oid1 or oid2 and store the results in/SNMP.txt

    ‘bulkget’ has the additional attribute repeat ="50", which determineshow many items after oid1 or oid2 to get

    Common Attributes Used with Tag Names Description

    Each attribute below can be used with any of the criteria tags to select items.

      switch_series="A2" Only executes on A2 Series switches

      vendor_part_number ="A2H124-24"

    Only executes on switches with the vendor part number A2H124-24

      oid1="sysDescr.0" Attempts to get the value for the sysDescr.0 OID

      oid2="1.3.6.1.2.1.1" If the oid1 get fails, then a second get is performed using oid2

    The special action attribute below saves the results of the ‘get’ to the Equipment Info for the switch.

      equipment_info=  "SERIAL_NUMBER"

    Store the retrieved data in equipment info for the item under the keySERIAL_NUMBER.

  • 8/19/2019 FERRET V5.4

    34/62

    B0860AZ – Rev A 4. 70 Series FERRET User Interface

    24

    File Data / File Info / Paths ScreensEach of these screens contains lists of paths or files that FERRET should collect. You can add orsubtract any files you wish to collect in addition to the normal FERRET data.

    NOTE

    Care should be taken not to collect large files as they have to be copied back to the

    host station and may cause network problems.

    Figure 4-6. 70 Series User Interface - File Data/File Info/Paths Screens

  • 8/19/2019 FERRET V5.4

    35/62

    25

    5. Command Line Parameters 

    This chapter describes the command line parameters that can be used to automate FERRETcollections.

    Previous versions of FERRET could be automated using the command line parameters of theFERRET.exe executable.

    These command line parameters are no longer part of FERRET.exe, but have been moved to theferret_gather.exe in the \bin sub-directory. If you want to automate FERRET, thef erret_gather.exe should be used instead of FERRET.exe.

    FERRET V5.4 provides the feature “Scheduled Runs” that should be used when automatingFERRET collections.

    The two functions within FERRET that use the command line parameters offerret_gather.exe are:

    Collections on remote machinesFERRET copies ferret_gather.exe and ferret_gather.xml to a remotemachine and executes it passing the location of the ferret_gather.xml file.

    Scheduled Runs

    The FERRET Scheduled Run function works by using Windows Task Scheduler andpassing it a task to execute to the ferret_gather.exe. See Chapter 7 “ScheduledRuns (Unattended Execution)” for more information.

    Table 5-1. Command Line Parameters - ferret_gather.exe

    Parameters Description/station:LBUG Letterbug of the station from which FERRET should collect. Usually, it is

    the current station. If this parameter is set, no other stations in theferret_gather.xml file will be collected.

    /gather:XML file-name

    The full path and file name of the ferret gather xml file to be used. If thisentry is omitted, the xml file in the /data sub directory is used.

    /site Starts a silent run of FERRET using the ferret_gather.xml file in the /datasub directory.

    /logline:nnn Starts the site log file at line number nnn.

    /debug Creates a debug output file named ferret_gather_debug.log in the same

    directory as the ferret_gather.exec file./task:{taskname} Loads and executes the scheduled run {taskname} from the tasks xml file

    (\opt\fox\bin]remote\tools\ferret\data\FERRET_tasks.xml).

  • 8/19/2019 FERRET V5.4

    36/62

    B0860AZ – Rev A 5. Command Line Parameters

    26

    Table 5-2. Command Line Parameters - fes.exe

    Command Description

    -u Uninstalls the ferret_gather service from the current machine. This call will not remove the fes.exe file.This parameter is used by the FERRET installer.

    -i Installs the ferret_gather service on the current machine.This parameter is used by the FERRET installer.

    -v Displays the version of the ferret_gather service and whether the service iscurrently installed.

  • 8/19/2019 FERRET V5.4

    37/62

    27

    6. FERRET Menus 

    This chapter describes the menus in FERRET and their functions.

    File MenuThe File menu allows you to perform tasks such as, create FERRET xml file, open FERRET DATfiles or save to external storage, schedule a run, and display the letterbug of the Host station.

    Figure 6-1. FERRET Menus - File Menu

    Table 6-1. File Menu

    Option Description

    New Creates a new ferret_gather.xml file.

    Note: This option removes all status information from the RunStatus screen including the run log. However, the second IP Address stored on the Station Exclude screen will not be cleared.

    Open Opens an existing ferret_gather.xml file.

    Note: This option updates all status information on the RunStatus screen from the ferret_gather.xml file that is opened.However, the second IP Address stored on the Station Excludescreen will not be cleared.

    Save Saves all the settings to the ferret_gather.xml file.

    Save As Saves the file to a new ferret_gather.xml file.

    Save FERRET file Saves a copy of the collected FERRET file.

    Run As Changes the user account under which the FES service is run-ning.

    Schedule Run Configures FERRET to perform a run at a scheduled time. SeeChapter 7 “Scheduled Runs (Unattended Execution)” for moreinformation.

  • 8/19/2019 FERRET V5.4

    38/62

    B0860AZ – Rev A 6. FERRET Menus

    28

    Edit MenuThe Edit menu allows you to edit information in a text field.

    Figure 6-2. FERRET Menus - Edit Menu

    View MenuThe View menu allows you to change the displays in FERRET as well as show various reports.

    Figure 6-3. FERRET Menus - View Menu

    FERRET Host Machine Displays the letterbug of the Host machine for the FERRETrun.

    Exit Exits the FERRET application.

    Table 6-2. Edit Menu Options

    Option Description

    Undo Undoes the last edit

    Cut Cuts text and saves to the clip-board

    Copy Copies text to the clipboard

    Paste Pastes text from the clipboard

    Table 6-1. File Menu (Continued)

    Option Description

  • 8/19/2019 FERRET V5.4

    39/62

    6. FERRET Menus B0860AZ – Rev A

    29

    Table 6-3. View Menu Options

    Option Description

    Toolbar Toggles the toolbar On and Off.

    Status Bar Toggles the status bar On and Off.

    Split Moves the splitter bar.Log File Shows the Sites log file in Notepad. See Appendix A “FERRET Site Log” for a

    sample report.

    NetMon Report Generates a text file that can be opened by the Microsoft Network Monitor(netmon). This text file contains the MAC address, letterbug, and descriptionof every station at site. See Appendix B “NetMon Report” for a sample report.

    DiagFist Report Generates a text file that contains the letterbug, station type, station address,Primary MAC address, Shadow MAC address and IP address for each station atsite. See Appendix C “DiagFist Report” for a sample report.

    Site Equipment

    Report

    Generates a text file that contains all stations and devices at the site. The text file

    is tab delimited so it can be easily opened in an Excel®

    spreadsheet. It isgrouped by Node and then Station Host. See Appendix D “Site EquipmentReport” for a sample report.

    By Monitor Groups the stations in the “Station Exclude” screen by system monitor.

    By Node Groups the stations in the “Station Exclude” screen by Node.

    Refresh Reloads and redisplays the current view.

  • 8/19/2019 FERRET V5.4

    40/62

    B0860AZ – Rev A 6. FERRET Menus

    30

  • 8/19/2019 FERRET V5.4

    41/62

    31

    7. Scheduled Runs (UnattendedExecution) 

    This chapter describes configuring FERRET to perform an unattended collection at a scheduledtime.

    FERRET can perform scheduled runs for its collections. This means you can configure what you want to collect and have that collection performed at a planned time in the future. All ScheduledRuns are performed by automatically creating a task using Windows Task Scheduler. The Win-dows Task Scheduler can be displayed by opening Control Panel and Selecting “Task Scheduler”

    Scheduled Runs fall into three categories:

    1. One time FERRET collection. A collection that executes at a predetermined time

    2. Recurring collection (Daily, Weekly or Monthly). A collection that re-occurs after a

    pre-determined time period3. Repeatable runs. A collection that repeats after an elapsed time period. A repeatable

    run is different from a recurring run in that it will only repeat for the day on whichthat collection is scheduled to start.

    NOTE

    It is recommended to lower the throttle for unattended executions.

    NOTE

    On Windows 7 and Server 2008 stations, you must run FERRET as Administratorfor this function. Right-click FERRET.exe and choose "Run as Administrator".

    Opening the Scheduled Run DialogFrom the File menu, select File > Schedule Run to open the Scheduled Run dialog as shownin Figure 7-1.

  • 8/19/2019 FERRET V5.4

    42/62

    B0860AZ – Rev A 7. Scheduled Runs (Unattended Execution)

    32

    Figure 7-1. Scheduled Runs - Schedule Run Dialog

    Table 7-1. Scheduled Runs - Schedule Run Options

    Option Description

    Task List A list of all the FERRET collections that are scheduled to run. The task needsto be checked in order for it to be scheduled.The Desc column displays a summary of when the collection will be per-formed. The user can click on the description to edit the task.

    Delete Removes the selected task. Click on the Task Name first and then select Delete.

    New Creates a new task. The user is prompted for the task name.Once created, click on the task description to edit the task.

    OK Closes the dialog and saves any edits the user has made. A new Windows Scheduled Task is created for any tasks that you have checked.

    Cancel Closes the dialog and discards any edits.

  • 8/19/2019 FERRET V5.4

    43/62

    7. Scheduled Runs (Unattended Execution) B0860AZ – Rev A

    33

    Creating a Scheduled RunTo create a new Scheduled Run, perform the following steps.

    1. From the main screen of FERRET, select File > Schedule Run.

    2. In the Scheduled Run dialog, click the New button.

    3. In the New scheduled run dialog (Figure 7-2), type a descriptive name for the collec-

    tion.Names cannot contain the following characters:

    < (less than)

    > (greater than)

      : (colon)

    " (double quote)

    / (forward slash)

    \ (backslash)

    | (vertical bar or pipe)

    ? (question mark)

    * (asterisk)

    Figure 7-2. Scheduled Runs - New Scheduled Run Dialog

    4. Click the OK button.

     Your new Scheduled Run is added to the list in the Scheduled Run dialog, but does not appear aschecked and therefore, is not actually scheduled. When you want the run to be scheduled, youmust select the checkbox for that run. See Figure 7-1.

    NOTE

     An empty schedule run has been created. In order to set all the necessary options,

    you need to edit the run using the Wizard. See “Editing a Scheduled Run” onpage 34.

  • 8/19/2019 FERRET V5.4

    44/62

    B0860AZ – Rev A 7. Scheduled Runs (Unattended Execution)

    34

    Editing a Scheduled RunOnce you create a Scheduled Run, you need to edit the settings described in Table 7-2. To see theSchedule Run Wizard used to change the settings, click on the task description in the ScheduledRun dialog (Figure 7-1). The wizard is responsible for setting all the collection parameters thatFERRET uses when the task is run. See Figure 7-3, Figure 7-4 and Figure 7-5 for descriptions ofthe Wizard.

    Scheduled Run Wizard - Dialog 1In the first dialog of the wizard, enter when you want the task to run. You have the same basicchoices as you would in the Windows Task Scheduler. In addition to entering when to run thetask, choose how many runs to save, if it is a recurring task.

    If you choose the “Save Run for RemoteWatch” option, then the data from the collection is savedin a special folder that is collected by RemoteWatch. This collection is then transferred to theRemoteWatch server and stored.

    Figure 7-3. Scheduled Runs - Schedule Run Wizard Dialog 1

  • 8/19/2019 FERRET V5.4

    45/62

    7. Scheduled Runs (Unattended Execution) B0860AZ – Rev A

    35

    Table 7-2. Scheduled Runs - Schedule Run Wizard Dialog 1

    Settings Descriptions

    Name The name of the task.

    Schedule Run The frequency that the task should execute. Your choices are:

    Once

    Daily 

     Weekly (same weekday as start date)

    Monthly (same weekday as start date).

    Start DateStart Time

    The date and time that the task will begin executing.

    End Date Check this box and enter an end date and time to end a recurringschedule.

    Note: This date and time does not stop a task if it is in the process ofcollecting data. It only stops the task from running at the next sched-uled time.

    Stop the run if it runs lon-ger than

    Check this box and enter the duration in hours and minutes in whicha collection should be stopped. This ensures that a long running col-lection does not interfere with normal site operation.

    Continue previous run if itdid not finish

    If a long running collection is stopped and this task has a recurringschedule, the next time the task starts it continues from where it wasinterrupted.

    Cancel schedule after fullFERRET run completed

    This is similar to the End Date selection but instead of stopping theschedule at a specified date and time, it stops the schedule after FER-RET has performed a full collection.

    Note: If any stations were not collected (problem stations) the sched-ule is still stopped. It is up to the user to perform any manual collec-tions necessary to complete the run. See Run FERRET on problemstations.

    Repeat Run

    Until

    If checked, the task is repeated after the entered duration has elapsed.

    The repeated task continues until the entered end time has been

    reached.

    Keep ** ALL ** runs FERRET saves all runs from this task. Each run is saved in a folder with the Scheduled Runs name, which is a timestamp. See “ScheduledRun Output Files” on page 38.

    Keep n runs FERRET only saves the number of runs entered. The runs are saved inthe Scheduled Run folder. See “Scheduled Run Output Files” onpage 38.

    Save run for RemoteWatch The run is put in a folder that RemoteWatch collects during its run.

  • 8/19/2019 FERRET V5.4

    46/62

    B0860AZ – Rev A 7. Scheduled Runs (Unattended Execution)

    36

    Scheduled Run Wizard - Dialog 2The second dialog of the wizard allows you to specify the type of run you want FERRET to per-form. This dialog is the same as the Run Types screen you would use when doing a FERRET run.See “Run Types Screen” on page 15 in Chapter 4 “70 Series FERRET User Interface”.

     When you have finished making your selections, click the Next button.

     

    Figure 7-4. Scheduled Runs - Schedule Run Wizard Dialog 2

  • 8/19/2019 FERRET V5.4

    47/62

    7. Scheduled Runs (Unattended Execution) B0860AZ – Rev A

    37

    Scheduled Run Wizard - Dialog 3The final dialog of the wizard allows you to specify on which stations you want FERRET to run.This dialog is the same as the Station Exclude screen you would use when doing a FERRET run.See “Station Exclude Screen” on page 21 in Chapter 4 “70 Series FERRET User Interface”.

     When you have finished making your selections, click the Next button.

     

    Figure 7-5. Scheduled Runs - Scheduled Run Wizard Dialog 3

  • 8/19/2019 FERRET V5.4

    48/62

    B0860AZ – Rev A 7. Scheduled Runs (Unattended Execution)

    38

    Scheduled Run Output Files When the Scheduled Run executes, the output for the run is stored in the FERRET\Scheduledsubdirectory. Each Scheduled Run has its own sub folder. Each collection of the Scheduled Runhas as a FERRET file and a log file for the collection. The file names are time stamps. The time-stamp is the Date and Time the Scheduled Run was executed.

    Example of Scheduled Run subdirectory:

     

    Figure 7-6. Scheduled Runs - Scheduled Run Sub-directory

    NOTE

    The file 30MAR2010_140001.txt is a special file used by FERRET during its col-lection. This is the continue run file which is created when a FERRET collectionstarts. During its run FERRET periodically saves its data to the file30MAR2010_140001.fer. When FERRET completes the collection it removes thetext file, which allows FERRET to continue the last run if it was stopped.

    Contents of the continue run text file:

    Continue run file

    If this file is here after run stops then the run was not complete.

  • 8/19/2019 FERRET V5.4

    49/62

    39

    8. FERRET for Triconex Equipment 

    This chapter describes using Triconex ™ firmware files with FERRET 

    Triconex firmware files are extracted from Tricon™ and Trident™ systems by using the Tri-Sta-tion™ or Enhanced Diagnostics Monitor software packages. These files represent one Tricon orTrident system and contain a listing of firmware revision levels by chassis. A single site may con-tain many Triconex systems.

    In previous versions of FERRET, you could convert these files to a site equipment list by import-ing them into FERRET. FERRET would attempt to convert the firmware into part numbers asbest it could. This functionality has been moved from FERRET to the System Asset Viewerproduct.

    To use the Triconex firmware files you must use the System Asset Viewer product. The System Asset Viewer application allows you to import and modify Triconex firmware files in the wayolder versions of FERRET did.

    System Asset Viewer is available on the Global Customer Support website:http://support.ips.invensys.com .

  • 8/19/2019 FERRET V5.4

    50/62

    B0860AZ – Rev A 8. FERRET for Triconex Equipment

    40

  • 8/19/2019 FERRET V5.4

    51/62

    41

    9. Considerations

    This chapter describes some of the problems you might encounter when doing a FERRETcollection.

    Site Equipment ListThe site equipment list created needs to be checked before leaving the site. Open the FERRETfile collected in System Asset Viewer and review the site equipment list created by System AssetViewer.

    FERRET cannot see what is not configured or not physically present. Also, errors may be encoun-tered. Therefore, it is highly recommended that the output and log files be checked to ensureaccuracy of the data.

     A review of these files with the customer would help ensure all exceptions and discrepancies are

    accounted for in the calculation of the system.The Field Service Representative will forward the FERRET file to the Field Service Manager orService Sales Representative unless otherwise instructed.

    Items not collected by FERRET include:

    CRTs and Flat-Panel displays

    Touchscreen displays

    Base Plate Power Modules

    Base Plates

    Cabinets

    Termination Assemblies

    Node Bus Extenders

    Switch Chassis

    Switch Power Modules

    Off-Platform workstations

    Cables

    Solaris on the Mesh - Needs Telnet / ftp on and the root account password must begnomes.

    Network Equipment CalculationsThere may be a discrepancy with the number of Dual Nodebus Interface Modules (DNBT,DNBI, RCNI and NCNI). If the site has 70 Series stations, it is possible that FERRET will notaccurately calculate the number of DNBT, DNBI, RCNI or NCNI modules. If your site has 70Series stations configured, verify this number.

  • 8/19/2019 FERRET V5.4

    52/62

    B0860AZ – Rev A 9. Considerations

    42

    FBM and ECB CountsFBM vs. ECB counts may differ. FERRET checks for both FBM hardware types and ECB soft- ware. Certain FBM hardware supports many different software types. It is possible that the FBMhardware count may be different and not exactly match the number of ECBs in the software sec-tion of the report.

    FERRET Output with Installed Base RepositoryThe Service Sales Representative or other designated person uses FERRET files in conjunction with the Global Product Support Installed Base Repository: http://support.ips.invensys.com .

    Following is a brief summary concerning the use of FERRET output files:

    Ensure Installed Base Repository users have authorization to upload FERRET files.Email the web master to request access to do so.

    Upload all files output by the FERRET program.

     After uploading the files, make sure to review and edit the equipment listed in the

    repository.This function is the best way to create a www.BuyAutomation.com basket with support agree-ment pricing.

    FERRET Output and www.BuyAutomation.comThe Service Sales Representative or other designated person uses FERRET files in conjunction with www.BuyAutomation.com to calculate installed system value and support agreement pricinginformation.

    BuyAutomation users must have Service Extranet authorization to utilize BuyAutomation's capa-

    bilities related to pricing support agreements.

  • 8/19/2019 FERRET V5.4

    53/62

    43

    10. FERRET Software Subdirectory 

    This chapter describes the contents of the FERRET subdirectory.

    The FERRET subdirectory contains all the files needed for running FERRET. These files remainon the hard disk until a Field Service Engineer or the customer removes them.

    Table 10-1. 70 Series FERRET Subdirectory

    Files / Sub-directoryNames Description

    FERRET.exe A Windows executable that is the main program for FERRET. It isalso known by the name FERRET Management Console.

    /bin subdirectory This directory contains all the utilities needed by FERRET to run(remd/remv, frev, pc, tar).

    /bin/fes.exe FERRET Execution Services. fes.exe is copied to AW70s and WP70s. FERRET uses this program for remote collection. It willinstall itself as the ferret_gather service on the remote machine andrespond to requests from the FERRET application.

    /bin/ferret_gather.exe The FERRET gather executable. This file is copied to remote AW70sand WP70s and executed remotely using FERRET Execution Ser-vices.

    /bin/smon_get.exe The smon_get executable is used to retrieve smon data for all work-stations at the site.

    /bin/foxfdr.dll This file is required for smon_get to run on older workstations(with I/A Series V6.x and I/A Series V7.x system software).

    /bin/snmpget.exe The snmpget executable is responsible for retrieving snmp data fromswitches.

    /Data subdirectory This directory contains the file site.fer file and the gather.xmlfile.

    /Data/site.fer This file is the FERRET file for the entire site. It is created after eachrun of FERRET. The user can also get a FERRET file for the entire

    site by running FERRET and choosingFile

     >Save FERRET File

    ./Data/ferret_gather.xml This file directs FERRET as to what to collect for its next run. TheFERRET application modifies this file. It can also be modifiedmanually.

    /Data/FERRET_tasks.xml This file contains all the information FERRET needs to execute ascheduled run.

  • 8/19/2019 FERRET V5.4

    54/62

    B0860AZ – Rev A 10. FERRET Software Subdirectory

    44

    /gather sub directory This subdirectory is where FERRET places collected files from remotestations. After the FERRET collection, this directory is cleaned out.The files will be the letterbug of the station.

    Example: AWXP01.fer.

    /mibs This directory contains the MIBs that describe the Enterasys switches.FERRET uses these MIBs when collecting data via SNMP.

    /output This directory contains output from user-defined scripts. The outputis copied from the remote station and stored in a subdirectory withthat station’s letterbug.

    /scripts This directory contains the user-defined scripts that FERRET executesduring its run. It is broken down into two subdirectories: 51_Seriesand 70_Series.

    Table 10-2. 20/50/51 Series FERRET Subdirectory

    Scripts Description

    FERRET This shell script is the main program. It performs the following opera-tions: Using the contents of /usr/fox/sp/hldb builds a list of acces-

    sible host processors including PWs, AP10s, AP20s, AP50s, AW50s, WP50s, AP51s, AW51s, WP51s, AP70s, and WP70s.

     Attempts to connect to each of the above hosts and, if successful,

    gathers the relevant information from the remote host station. Combines the output generated on the individual hosts into a

    single Tar file containing data for the entire site and thenprompts user to save the output file.

    bridge.sh UNIX Shell Script used to connect to each remote host from whichFERRET needs to gather information.

    gather.sh UNIX shell script used to gather data for each remote AW and WP.This program calculates the counts for: Stations Peripherals attached to a COMM processor

     Workstation peripherals Standard and optional software licenses Third-party software packages Library volumes Additional display manager licenses.

    gatherDataTopo.sh UNIX shell script used to gather information from the points data-bases. This information is used to provide a Data Topology report forthe site.

    save2dos UNIX shell script used to format floppies and save FERRET files.

    Table 10-1. 70 Series FERRET Subdirectory (Continued)

    Files / Sub-directoryNames Description

  • 8/19/2019 FERRET V5.4

    55/62

    45

    Appendix A. FERRET Site Log 

    This appendix describes the output of the FERRET log file.

    For each run, FERRET creates a site log file. This log file is actually the combination of multiplelog files, one for each station from which FERRET has collected information and one for the hoststation on which FERRET was started.

    The log file contains the following information:

    Run information showing when the FERRET software was run, the version of FER-RET, and the host station on which FERRET was run.

    The type of information selected for and omitted from the run, such as “Gather Stan-dard Data not selected”, “Gather Data Topology selected” and “Recheck missingstations not selected”. See Figure A-1.

    The log information for each station, which includes:

     A log line number (00327)

     A timestamp (03-31-2010 17:23:48)

    The letterbug of the station executing code followed by a period (MSRINF)

    The letterbug of the station being collected (AWSL10) or dashes ------ if it is thesame station.

    The text of the log entry (Pinging AWSL10).

    Figure A-1. FERRET Site Log

  • 8/19/2019 FERRET V5.4

    56/62

    B0860AZ – Rev A Appendix A. FERRET Site Log

    46

  • 8/19/2019 FERRET V5.4

    57/62

    47

    Appendix B. NetMon Report 

    This appendix describes the NetMon report created by FERRET.

     After a collection has been performed, you can create the NetMon report from the View menu.This report is a list of all the MAC addresses for each station at the site. The format of the reportis designed so that it can be easily loaded into the Microsoft Network Monitoring tool.

    For each station, the MAC address along with the station letterbug and description is output tothe report. Any fault-tolerant station also has its Primary and Shadow addresses listed.

    Figure B-1. NetMon Report

  • 8/19/2019 FERRET V5.4

    58/62

    B0860AZ – Rev A Appendix B. NetMon Report

    48

  • 8/19/2019 FERRET V5.4

    59/62

    49

    Appendix C. DiagFist Report 

    This appendix describes the output of the FERRET DiagFist report.

    The DiagFist report produces a list of the stations at the site along with their MAC and IPaddresses. If any station has a second IP Address, FERRET lists that address as well. SeeFigure C-1.

    Figure C-1. DiagFist Report

  • 8/19/2019 FERRET V5.4

    60/62

    B0860AZ – Rev A Appendix C. DiagFist Report

    50

  • 8/19/2019 FERRET V5.4

    61/62

    51

    Appendix D. Site Equipment Report 

    This appendix describes the output of the Site Equipment report.

    The Site Equipment report is a list of all the stations and devices for which FERRET has collectedinformation. The data output is grouped by the node and the station host within the node. Foreach station, its letterbug, Host station, description, monitor letterbug and OS version are dis-played. For each device, its letterbug, Host station, description, monitor letterbug, EEPROMrevision, and software revision are displayed.

    The tab delimited report can be opened in an Excel spreadsheet.

    Figure D-1. Site Equipment Report

  • 8/19/2019 FERRET V5.4

    62/62

    Invensys Operations Management5601 Granite Parkway Suite 1000Plano, TX 75024United States of Americahttp://www.iom.invensys.com

    Global Customer Support

    Inside U.S.: 1-866-746-6477Outside U.S.: 1-508-549-2424 or contact yourlocal Invensys representative