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

  # Kiwi CatTools CatOS Port Usage Format

  plugin_version = "1.1.1"

  # 2006-10-16 - 1.1 - GMF - Added tx_octets tracking
  # 2011-04-04 - 1.1.1 - MSG - Edited info lines.

  info.1.manufacturer = "SolarWinds"
  info.1.device = "Kiwi CatTools CatOS Port Usage"
  info.1.version.1 = ""

  info.2.manufacturer = "Kiwi"
  info.2.device = "CatTools CatOS Port Usage"
  info.2.version.1 = ""
 
  # The name of the log format
  log.format.format_label = "Kiwi CatTools CatOS Port Usage Format"
  log.miscellaneous.log_data_type = "network"  
  log.miscellaneous.log_format_type = "syslog_server"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "^Switch Name	Device Type	Slot & Port	Type	Description	Duplex	VLAN	Status	Speed	Security	Rx Octets	Tx Octets"

  # Fields are separated by tabs
  log.format.field_separator = "	"

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

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

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

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

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

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

  } # log.fields


  # Database fields
  database.fields = {

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

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

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

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

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

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

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

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

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

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

  } # database.fields


  # Log Filters
  log.filters = {


    # Reject this entry if the value of the Switch Name field is Switch Name (i.e. reject the header line)
    1 = {
      label = "1"
      comment = ""
      value = "if (switch_name eq 'Switch Name') then 'reject';"
    } # 1


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

  } # log.filters

  database.numerical_fields = {

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

    rx_octets = {
      label = "$lang_stats.field_labels.rx_octets"
      default = false
      requires_log_field = true
      log_field = "rx_octets"
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # rx_octets

    tx_octets = {
      label = "$lang_stats.field_labels.tx_octets"
      default = false
      requires_log_field = true
      log_field = "tx_octets"
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # tx_octets

  } # database.numerical_fields


  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      switch_name = true
      device_type = true
      slot___port = true
      type = true
      description = true
      duplex = true
      vlan = true
      status = true
      speed = true
      security = true
    } # report_groups

  } # create_profile_wizard_options

} # kiwi_cattools_port_stat