Professional Documents
Culture Documents
Ferret V5.4
Ferret V5.4
FERRET V5.4
(Windows Platforms)
and FERRET V4.5.3
(UNIX Platforms)
Users Guide
B0860AZ
Rev A
August 30, 2012
Invensys, Foxboro, I/A Series, the Invensys logo, Tricon, Triconex, Trident and TriStation are trademarks of
Invensys plc, its subsidiaries, and affiliates.
All other brand names may be trademarks of their respective owners.
Copyright 2012 Invensys Systems, Inc.
All rights reserved
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 ............................................................................... 12
Merging 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
iii
B0860AZ Rev A
Contents
34
34
36
37
iv
Figures
2-1.
2-2.
2-3.
2-4.
3-1.
3-2.
3-3.
4-1.
4-2.
4-3.
4-4.
4-5.
4-6.
6-1.
6-2.
6-3.
7-1.
7-2.
7-3.
7-4.
7-5.
7-6.
A-1.
B-1.
C-1.
D-1.
B0860AZ Rev A
vi
Figures
Tables
2-1.
2-2.
2-3.
4-1.
4-2.
4-3.
4-4.
4-5.
4-6.
4-7.
5-1.
5-2.
6-1.
6-2.
6-3.
7-1.
7-2.
10-1.
10-2.
vii
B0860AZ Rev A
viii
Tables
Preface
This document is intended for use by Field Service Representatives. It provides specific information and procedures for configuring and running FERRET including collecting System Management Information, switch data via SNMP, and station information via I/A Series configuration
files. For FERRET installation details for 50 Series and 70 Series stations, refer to the FERRET
Installation Guide (B0860RC).
Revision Information
This is the initial release of this document.
Reference Documents
In addition to the information presented herein, you should be familiar with the following
I/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 Configuration
Guide (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 Customer
Support Center at http://support.ips.invensys.com.
Glossary
FERRET
Installed Base
Repository
ix
B0860AZ Rev A
Preface
1. Introduction
This chapter serves as an introduction to FERRET and covers how to select basic functions and
menu items.
FERRET is intended for use by Field Service Representatives. It provides for collecting the site
information data in a single FERRET file (called a DAT file). This single file can be used with the
RemoteWatch server offering, uploaded to the Invensys Equipment Repository, or opened in the
System Asset Viewer product.
Separate versions of FERRET are offered for each supported operating system. The most current
versions 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 defined
by the commit diskette produced by the System Definition application, you can begin using
FERRET.
The best way to become familiar with FERRET is to just sit down and use it. Use a pointing
device (mouse or trackball) to make selections.
NOTE
Pointing Devices
For 70 Series stations with FERRET software, the cursor is the primary means for making menu
selections and for selecting FERRET functions or data fields. Cursor control is available through a
touchscreen, 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 mouse
moves over it.
In some functions, auxiliary keystrokes from an alphanumeric keyboard are necessary for implementation. Two examples are:
B0860AZ Rev A
1. Introduction
Keyboard
For 50 Series stations with FERRET software, the only input method is the keyboard. This is
because the 50 Series version of FERRET is a script running in a VT terminal window. Keyboard
entries are limited to choosing menu items and entering site information data.
After FERRET completes the collection program, you need to import the compressed tar file created by the UNIX version into System Asset Viewer to complete
the run.
Starting FERRET
Executing the script FERRET starts the collection programs on the main station host. Upon completion you are prompted to save the compressed tar file to a diskette. 50 Series processors format
the diskette with a DOS format, while 20 Series processors need to have a DOS formatted diskette 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 cmdtool, 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
B0860AZ Rev A
Option
Description
2
3
B0860AZ Rev A
and rsom have been known to cause some 51B stations to reboot. Appropriate
care should be taken when choosing this option.
som
Option
Description
2
3
Skip collection.
Exit and Quit.
Notes
See previous note regarding
som and rsom.
B0860AZ Rev A
Field
Site Name
Site Location
Process Unit Identification
Service Representative Name
FoxWatch 3 Letter Code
Description
The name of this site. The name should be the same as the site
name in the Installed Based Repository.
Location of the site, for example: Dallas, Texas.
Name identifying Process Unit, for example: Boiler.
Name of FSR running FERRET.
Three letter FoxWatch code, if one exists.
B0860AZ Rev A
B0860AZ Rev A
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 substantially longer.
NOTE
When running FERRET on I/A Series V8.8 security enhanced stations, you must
not be logged in with an account in the IAInstaller group. This group installs applications only.
B0860AZ Rev A
For I/A Series stations without a 2nd LAN connection, the data collection fails. You must then
run 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 is
a bridge node for the site. You should enter the 2nd IP address for any station that has a 2nd
Ethernet card. See Figure 3-1.
Figure 3-1. ATS in Extender Mode Shown on the FERRET Station Exclude Screen
10
B0860AZ Rev A
11
B0860AZ Rev A
12
B0860AZ Rev A
13
B0860AZ Rev A
14
Data Topology collects OM data to determine IPC issues, such as ghost lists. This is
not required for a Site Equipment list.
15
B0860AZ Rev A
Type
Standard Data
SysMgmt Data
SNMP Data from Switches
Vendor Part Number Only
16
Description
Collects all standard data including everything from the File Data,
File Info and Paths screen. It also collects the Add/Remove programs list, the Windows Services list, and the current BIOS information.
Uses frev or remv/remd to collect Equipment Information from
system management.
Uses the Nutcracker SNMP utility to query the SNMP database on
switches.
Only collects one piece of data from each switch, the sysDecr.0
OID. This allows FERRET to identify the Vendor part number and
subsequently the Invensys part number.
Performs a SNMP walk and collects the entire SNMP database
from the switch. This setting resets after each run of FERRET to
Vendor Part Number.
Note: The SNMP database is very large and should only be collected when its information is needed.
B0860AZ Rev A
Type
User Defined
Data Topology
Check Monitors
User Defined Scripts
Recheck Missing Stations /
Monitors
Continue Run
Check / Uncheck All
Throttle
Description
Uses the xml settings from the User Defined SNMP screen when
collecting data.
Uses the som/rsom and ps utilities to collect information from the
points database on CPs and workstations. This data can be used to
create a Data Topology report in the Installed Base Viewer.
This option performs a global find (GLOF) for each system monitor.
Runs each selected script on the User Scripts screen. Any output
from these scripts is copied back to the host station.
Rechecks those stations that FERRET normally skips if not found
with GLOF. Use this run type when bringing stations online.
Continues a previous run of FERRET. You are required to pick a
FERRET file that contains the previous run.
Selects or clears all options.
Slows the execution of FERRET.
Table 4-2. Run Display Buttons
Button
Reset to Factory Settings
Passwords
Start FERRET
Cancel
Description
Resets all settings in FERRET back to the Factory defaults.
Note: To perform a minimal run which collects enough data to create an Equipment List, select Reset to Factory Settings on the
Run Types screen. This action resets all selections on all screens to
what is needed for a minimum run of FERRET.
Changes the password for any stations that do not use the standard
fox account and password.
FERRET uses the standard fox account when connecting to Windows stations and root when connecting to UNIX stations. It always
uses gnomes as the password.
Note: The changed passwords are not saved and are only used for this
instance of FERRET.
Starts FERRET and is the same as the Start FERRET button on the
toolbar.
Stops FERRET once a collection has started.
17
B0860AZ Rev A
Clicking on any of these stations shows the collection logs from the last run performed on that station, which is very useful when determining why a station was
not collected.
During a run, the station list (Figure 4-2) is updated with the current stations from which data is
being collected. FERRET displays a status in the Station Status column of any station it is collecting from in the current run. As FERRET installs and remotely collects data, you see this column
update.
18
B0860AZ Rev A
Icons
Description
A green checkmark appears if FERRET successfully collected all the data for
that station.
A red exclamation mark indicates FERRET found the station but was not able
to collect all the data for that station. This can happen if FERRET cannot connect to the station. You should run FERRET on that station choosing to collect
data from that station only.
A yellow question mark indicates if the station was found in a configuration file
or System Management but FERRET was unable to locate the station via
GLOF. This might mean the station is off-line or that the configuration files
needs to be updated. (Commit disk needs to be applied.)
The station icon appears while FERRET is collecting its data.
Heading
Letterbug
Desc
Last
Collection
Station Status
Description
List of all station and switch letterbugs at the site. The icon for each station
denotes its status as described in Table 4-3.
Description of each station or node
Date and time of the last FERRET collection for each station
Description of the collection status for each station
19
B0860AZ Rev A
Field
Run InFormation
Name
Location
Process Unit
Service Rep
FoxWatch Code
Optional Information
Site ID
20
Description
Customer site name
Physical location (example, Dallas, TX)
Site function (example, Boiler)
Name of the Field Service Representative running FERRET
Three letter FoxWatch code, if one exists
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 customer site run.
B0860AZ Rev A
Column Heading
Letterbug
Desc
Last Run
Second IP Address
Station Status
Description
List of all station and switch letterbugs at the site. The icon for each station
denotes its status as described in Table 4-3.
Description of each station or node.
Date and time of the last FERRET collection.
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 stations with a second IP address are entered here.
Run status for each station.
21
B0860AZ Rev A
22
B0860AZ Rev A
Table 4-7. 70 Series User Interface - User-Defined SNMP XMLTag Names and Attributes
Tag Names
<walk/>
<get/>
<bulkget/>
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 determines
how many items after oid1 or oid2 to get
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=
Only executes on switches with the vendor part number A2H124-24
"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=
Store the retrieved data in equipment info for the item under the key
"SERIAL_NUMBER"
SERIAL_NUMBER.
23
B0860AZ Rev A
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.
24
Parameters
/station:LBUG
/gather:XML filename
/site
/logline:nnn
/debug
/task:{taskname}
Description
Letterbug of the station from which FERRET should collect. Usually, it is
the current station. If this parameter is set, no other stations in the
ferret_gather.xml file will be collected.
The full path and file name of the ferret gather xml file to be used. If this
entry is omitted, the xml file in the /data sub directory is used.
Starts a silent run of FERRET using the ferret_gather.xml file in the /data
sub directory.
Starts the site log file at line number nnn.
Creates a debug output file named ferret_gather_debug.log in the same
directory as the ferret_gather.exec file.
Loads and executes the scheduled run {taskname} from the tasks xml file
(\opt\fox\bin]remote\tools\ferret\data\FERRET_tasks.xml).
25
B0860AZ Rev A
Command
-u
-i
-v
26
Description
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.
Installs the ferret_gather service on the current machine.
This parameter is used by the FERRET installer.
Displays the version of the ferret_gather service and whether the service is
currently installed.
6. FERRET Menus
This chapter describes the menus in FERRET and their functions.
File Menu
The File menu allows you to perform tasks such as, create FERRET xml file, open FERRET DAT
files or save to external storage, schedule a run, and display the letterbug of the Host station.
Option
Description
New
Open
Note: This option removes all status information from the Run
Status screen including the run log. However, the second IP
Address stored on the Station Exclude screen will not be cleared.
Opens an existing ferret_gather.xml file.
Save
Save As
Save FERRET file
Run As
Schedule Run
B0860AZ Rev A
6. FERRET Menus
Option
Description
Exit
Edit Menu
The Edit menu allows you to edit information in a text field.
Option
Undo
Cut
Copy
Paste
Description
Undoes the last edit
Cuts text and saves to the clipboard
Copies text to the clipboard
Pastes text from the clipboard
View Menu
The View menu allows you to change the displays in FERRET as well as show various reports.
28
6. FERRET Menus
B0860AZ Rev A
Option
Toolbar
Status Bar
Split
Log File
NetMon Report
DiagFist Report
Site Equipment
Report
By Monitor
By Node
Refresh
Description
Toggles the toolbar On and Off.
Toggles the status bar On and Off.
Moves the splitter bar.
Shows the Sites log file in Notepad. See Appendix A FERRET Site Log for a
sample report.
Generates a text file that can be opened by the Microsoft Network Monitor
(netmon). This text file contains the MAC address, letterbug, and description
of every station at site. See Appendix B NetMon Report for a sample 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 at
site. See Appendix C DiagFist Report for a sample 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 is
grouped by Node and then Station Host. See Appendix D Site Equipment
Report for a sample report.
Groups the stations in the Station Exclude screen by system monitor.
Groups the stations in the Station Exclude screen by Node.
Reloads and redisplays the current view.
29
B0860AZ Rev A
30
6. FERRET Menus
NOTE
On Windows 7 and Server 2008 stations, you must run FERRET as Administrator
for this function. Right-click FERRET.exe and choose "Run as Administrator".
31
B0860AZ Rev A
Option
Task List
Delete
New
OK
Cancel
32
Description
A list of all the FERRET collections that are scheduled to run. The task needs
to be checked in order for it to be scheduled.
The Desc column displays a summary of when the collection will be performed. The user can click on the description to edit the task.
Removes the selected task. Click on the Task Name first and then select Delete.
Creates a new task. The user is prompted for the task name.
Once created, click on the task description to edit the task.
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.
Closes the dialog and discards any edits.
B0860AZ Rev A
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 on
page 34.
33
B0860AZ Rev A
34
B0860AZ Rev A
Settings
Descriptions
Name
Schedule Run
Start Date
Start Time
End Date
Repeat Run
Check this box and enter an end date and time to end a recurring
schedule.
Note: This date and time does not stop a task if it is in the process of
collecting data. It only stops the task from running at the next scheduled time.
Check this box and enter the duration in hours and minutes in which
a collection should be stopped. This ensures that a long running collection does not interfere with normal site operation.
If a long running collection is stopped and this task has a recurring
schedule, the next time the task starts it continues from where it was
interrupted.
This is similar to the End Date selection but instead of stopping the
schedule at a specified date and time, it stops the schedule after FERRET has performed a full collection.
Note: If any stations were not collected (problem stations) the schedule is still stopped. It is up to the user to perform any manual collections necessary to complete the run. See Run FERRET on problem
stations.
If checked, the task is repeated after the entered duration has elapsed.
Until
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 Scheduled
Run Output Files on page 38.
Keep n runs
FERRET only saves the number of runs entered. The runs are saved in
the Scheduled Run folder. See Scheduled Run Output Files on
page 38.
Save run for RemoteWatch The run is put in a folder that RemoteWatch collects during its run.
35
B0860AZ Rev A
36
B0860AZ Rev A
37
B0860AZ Rev A
NOTE
The file 30MAR2010_140001.txt is a special file used by FERRET during its collection. This is the continue run file which is created when a FERRET collection
starts. During its run FERRET periodically saves its data to the file
30MAR2010_140001.fer. When FERRET completes the collection it removes the
text 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.
38
39
B0860AZ Rev A
40
9. Considerations
This chapter describes some of the problems you might encounter when doing a FERRET
collection.
41
B0860AZ Rev A
9. Considerations
42
Files / Sub-directory
Names
Description
FERRET.exe
/bin subdirectory
/bin/fes.exe
/bin/ferret_gather.exe
/bin/smon_get.exe
/bin/foxfdr.dll
/bin/snmpget.exe
/Data subdirectory
/Data/site.fer
/Data/ferret_gather.xml
/Data/FERRET_tasks.xml
This directory contains the file site.fer file and the gather.xml
file.
This file is the FERRET file for the entire site. It is created after each
run of FERRET. The user can also get a FERRET file for the entire
site by running FERRET and choosing File > Save FERRET File.
This file directs FERRET as to what to collect for its next run. The
FERRET application modifies this file. It can also be modified
manually.
This file contains all the information FERRET needs to execute a
scheduled run.
43
B0860AZ Rev A
Files / Sub-directory
Names
Description
/mibs
This directory contains the MIBs that describe the Enterasys switches.
FERRET uses these MIBs when collecting data via SNMP.
This directory contains output from user-defined scripts. The output
is copied from the remote station and stored in a subdirectory with
that stations letterbug.
This directory contains the user-defined scripts that FERRET executes
during its run. It is broken down into two subdirectories: 51_Series
and 70_Series.
/output
/scripts
Scripts
FERRET
bridge.sh
gather.sh
gatherDataTopo.sh
save2dos
44
Description
This shell script is the main program. It performs the following operations:
Using the contents of /usr/fox/sp/hldb builds a list of accessible 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 then
prompts user to save the output file.
UNIX Shell Script used to connect to each remote host from which
FERRET needs to gather information.
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.
UNIX shell script used to gather information from the points databases. This information is used to provide a Data Topology report for
the site.
UNIX shell script used to format floppies and save FERRET files.
45
B0860AZ Rev A
46
47
B0860AZ Rev A
48
49
B0860AZ Rev A
50
51