# Copyright (c) 2010 Flowerfire, Inc.  All Rights Reserved.
cisco_net_flow = {

  plugin_version = "1.0.2"

  info.1.manfacturer = "Cisco Systems"
  info.1.device = "NetFlow"
  info.1.version.1 = ""

  # ????-??-?? - ??? - 1.0   - Initial implementation
  # 2009-07-29 - 1.0.1 - GMF - Changed start_time to date_time--date_time fields must be named date_time
  # 2010-10-20 - 1.0.2 - MSG - Edited info lines.

  # Cisco NetFlow

  # The name of the log format
  log.format.format_label = "Cisco NetFlow"
  log.miscellaneous.log_data_type = "firewall"  
  log.miscellaneous.log_format_type = "network_device"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "^(AGGREGATION_DEFINITION srcaddr\\|dstaddr\\||<nfc-output-header)"

  # The regular expression to parse lines
  log.format.parsing_regular_expression = "^([0-9.]+)\\|([0-9.]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)\\|([0-9]+)"

  # A log entry is called an event
  statistics.miscellaneous.entry_name = "events"

  # The format of dates and times in this log
  log.format.date_format = "seconds_since_jan1_1970"
  log.format.time_format = "seconds_since_jan1_1970"

  # Log fields
  log.fields = {

    source_ip = {
      label = "$lang_stats.field_labels.source_ip"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # source_ip

    destination_ip = {
      label = "$lang_stats.field_labels.destination_ip"
      type = "flat"
      index = 0
      subindex = 0
    } # destination_ip

    source_port = {
      label = "$lang_stats.field_labels.source_port"
      type = "flat"
      index = 0
      subindex = 0
    } # source_port

    destination_port = {
      label = "$lang_stats.field_labels.destination_port"
      type = "flat"
      index = 0
      subindex = 0
    } # destination_port

    protocol = {
      label = "$lang_stats.field_labels.protocol"
      type = "flat"
      index = 0
      subindex = 0
    } # protocol

    tos = {
      label = "$lang_stats.field_labels.tos"
      type = "flat"
      index = 0
      subindex = 0
    } # tos

    packets = {
      label = "$lang_stats.field_labels.packets"
      type = "flat"
      index = 0
      subindex = 0
    } # packets

    octets = {
      label = "$lang_stats.field_labels.octets"
      type = "size"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # octets

    flows = {
      label = "$lang_stats.field_labels.flows"
      type = "flat"
      index = 0
      subindex = 0
    } # flows

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      type = "date_time"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # date_time

    end_time = {
      label = "$lang_stats.field_labels.end_time"
      type = "flat"
      index = 0
      subindex = 0
    } # end_time

    active_time = {
      label = "$lang_stats.field_labels.active_time"
      type = "flat"
      index = 0
      subindex = 0
    } # active_time

  } # log.fields


  # Database fields
  database.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      log_field = "date_time"
      type = "string"
      suppress_top = 0
      suppress_bottom = 3
    } # date_time

    source_ip = {
      label = "$lang_stats.field_labels.source_ip"
      log_field = "source_ip"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # source_ip

    destination_ip = {
      label = "$lang_stats.field_labels.destination_ip"
      log_field = "destination_ip"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # destination_ip

    source_port = {
      label = "$lang_stats.field_labels.source_port"
      log_field = "source_port"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # source_port

    destination_port = {
      label = "$lang_stats.field_labels.destination_port"
      log_field = "destination_port"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # destination_port

    protocol = {
      label = "$lang_stats.field_labels.protocol"
      log_field = "protocol"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # protocol

  } # database.fields


  # Log Filters
  log.filters = {

    mark_entry = {
      label = '$lang_admin.log_filters.mark_entry_label'
      comment = '$lang_admin.log_filters.mark_entry_comment'
      value = 'events = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

    events = {
      label = "$lang_stats.field_labels.events"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # events

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "source_ip"
      type = "unique"
      display_format_type = "integer"
    } # visitors

    octets = {
      label = "$lang_stats.field_labels.octets"
      default = false
      requires_log_field = true
      log_field = "octets"
      type = "float"
      display_format_type = "bandwidth"
    } # octets

    packets = ""

  } # database.numerical_fields


  create_profile_wizard_options = {
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      date_time = true
      source_ip = true
      destination_ip = true
      source_port = true
      destination_port = true
      protocol = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    sessionpages = true
    pageviews = true
    daybyday = true
  } # not_supported

} # cisco_net_flow