NAME
    portinfoexp - makes XML exports from network device configurations

SYNOPSIS
     genallnrmexp --help|h --version|V --xmlconf|c=<filepath>
      --devconfdir|d=<dirpath> --reportname|r=STRING
      --mediadir|m=<dirpath> [devices]

DESCRIPTION
    Program generates XML files with statistic information about network
    devices and for group of devices. The configuration can be set from
    command line as program parameters or from XML configuration file, which
    is then set as xmlconf parameter. If "xmlconf" option is not used,
    export is printed to STDOUT.

    Exported information are:

    *
         all E1 lines with all channel groups and the correspoded serial interfaces.

    *
         all E3 lines with all sub-E1 lines

    *
         all SONET lines with all sub-E1 lines

    *
         summaries for each device and and group of devices

PARAMETERS
    devices
        The list of device names. Program expects, that exists file
        *devconfdir/devicename*. The device configuration will be read from
        this file.

        If "xmlconf" is used, all device parameters are ignored.

OPTIONS
    help
         --help|h

        Displays the usage message.

    version
         --version|V

        Displays version and license message.

    xmlconf
         --xmlconf|c=<filepath>

        Sets the path for XML configuration file. If is sets, all other
        options for an export setting are ignored.

    devconfdir
         --devconfdir|d=<dirpath>

        Path for the directory with device configurations. You have to
        ensure yourself, that configurations are up-to-date. It is
        recommended if the saving statistics into RRD files is used.

        It is ignored, when "xmlconf" is used.

    reportname
         --reportname|r=STRING

        The name for exported XML file. Use without any extension, xml
        extension is used. E.g.: for --reportname=RouterOne RouterOne.xml
        file is created.

        It is ignored, when "xmlconf" is used.

    mediadir
         --mediadir|m=<dirpath>

        The directory, where all media files will be saved. Media files can
        be:

        *   RRD files

        *   PNG images

        All media files have filename, which is set by "reportname". It is
        ignored, when "xmlconf" is used.

XML CONFIGURATION
    Program can use XML configuration file config.xml, see "xmlconf". There
    is all necessary configuration for to exports information about devices
    and groups.

    Example:

     <?xml version="1.0"?>
     <config>
      <devicesConfigDir>../test/confstubs</devicesConfigDir>
      <reportDir>../test/reports</reportDir>
      <mediaDir>../test/reports</mediaDir>
      <devices>
       <device id="routerGw1" ipaddr="routerGw1.someISP.net" />
       <device id="routerGw2" ipaddr="routerGw2.someISP.net" />
       <device id="routerGw3" ipaddr="routerGw3.someISP.net" />
      </devices>
      <groups>
       <group name="Routers group no.1">
         <report>Routers1</report>
         <member>routerGw1</member>
       </group>
      </groups>
     </config>

    Elemets:

    <config>
        Main config element, nothing else.

    <devicesConfigDir>
        See "devconfdir".

    <reportDir>
        Directory where XML exports are saved.

    <mediaDir>
        See "mediadir".

    <devices>
        Section with device information, it has number of nested <device>
        elements.

    <device>
        Element for one device, has parameters:

    <id>
        Device identifier.

    <ipaddr>
        Device IP address. In most cases, it is id with domain name. E.g.

         <device id="Router1" ipaddr="Router1.domain.net">

    <groups>
        Section with group information, it has number of nested <group>
        elements.

    <group>
        Element for one group, has parameter <name> for a group name. It has
        nested elements:

    <report>
        Name for the XML group export file.

    <member>
        This is reference for the device, which is member of current group.
        It must be an existed device identifier.

REQUIRES
    For a manipulating with RRD files rrdtool -
    http://oss.oetiker.ch/rrdtool/ is required.

COPYRIGHT
    Copyright (c) 2007 Miroslav Kubelik <koubel at volny dot cz>

