Quick Start Guide
=================

If you haven't already installed nipper, follow the procedures outlined
in the INSTALL file.

Before using nipper you will need the configuration of your network
device saved to a text file. Typically for Cisco devices the
procedure for obtaining this would be:

  1. Logon to Cisco device
  2. Enter Enable mode
  3. Type "show run"
  4. Capture the output to a file
  5. Logout

Once you have the configuration file and nipper is installed you are
ready. nipper does not (currently) automatically detect what type of
device you are about to perform an audit of, so it must be told.

For a Cisco IOS Switch with a configuration file stored in
/home/fred/switch.txt and output to an XML file the command would be:

  nipper --ios-switch --input=/home/fred/switch.txt --xml --output=audit.xml

The device types currently supported by nipper are specified using the
following command line parameters:

    --pix or --asa or --fwsm
    Treat input configuration as a PIX/ASA/FWSM-based Cisco firewall.

    --ios or --ios-router
    Treat input configuration as a IOS-based Cisco router. This is the
    default device type.

    --ios-switch
    Treat input configuration as a IOS-based Cisco switch.

    --ios-catalyst
    Treat input configuration as a IOS-based Cisco catalyst.

    --catos or --nmp
    Treat input configuration as a CatOS- or NMP-based Cisco Catalyst.

    --css
    Treat input configuration as a Cisco Content Services Switch.

    --netscreen or --screenos
    Treat input configuration as a ScreenOS-based Juniper Netscreen
    firewall device.

The order in which the options are specified is irrelevent. To get a full
list of options, use the following command:

  nipper --help



 ***************************************************************************
 *   nipper - The network infrastructure parser                            *
 *   Copyright (C) 2006 - 2007 by Ian Ventura-Whiting (Fizz)               *
 *   fizz@titania.co.uk                                                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program. If not, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************