icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Gigamon Metadata Application For Splunk
SHA256 checksum (gigamon-metadata-application-for-splunk_121.tgz) 130ce0ea5276e561faff99e6bb6a6ac4c160a1fdd6b1ab572d4e7a31f2627e1a
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Gigamon Metadata Application For Splunk

Overview
Details
The Gigamon Metadata Application for Splunk allows customers to easily select, index and display network metadata generated by the GigaSECURE Security Delivery Platform.

The GigaSECURE Security Delivery Platform allows users to extract and consolidate metadata from any monitored network traffic flows, package them into NetFlow v5, v9, IPFIX and CEF records, then send them to Splunk Enterprise for indexing. Gigamon has enriched the Metadata records with information including URL information, HTTP/HTTPS return codes, and DNS query/response information, all of which provide the ability to rapidly diagnose security events for use cases such as, identifying rogue DNS services, spotting potential Command and Control server communications using high entropy domains and detecting use of non trusted or self-signed certificates for SSL-decrypted traffic that could indicate nefarious activity.

Table of Contents

End User License Agreement

Installation and use of this app signifies acceptance of the Gigamon End User License Agreement(EULA) inclusive of any future updates.

Quick Start

Navigate to the Gigamon and Stream Integration section for a step-by-step installation path.

OVERVIEW

  • About Gigamon Metadata Application For Splunk
  • Release notes
  • Performance benchmarks
  • Support and resources

INSTALLATION

  • Hardware and Software Requirements
  • Installation steps
  • Deploy to a Single Server Instance
  • Deploy to a Distributed Deployment
  • Deploy to a Distributed Deployment with Search Head Clustering
  • Deploy to Splunk Cloud

USER GUIDE

  • Data types
  • Lookups
  • Configure Gigamon Metadata Application For Splunk
  • Troubleshooting
  • Upgrade

This app GigamonMetadataForSplunk replaces the old app GigamonIPFIXMetadataForSplunk Ver 1.1.0. It isrecommended to uninstall/remove the old app GigamonIPFIXMetadataForSplunk before installing this app, GigamonMetadataForSplunk.

OVERVIEW

Gigamon Metadata Application For Splunk allows a Splunk Admin the ability to configure Splunk Stream for Gigamon Specific elements over IPFIX or CEF.

Scripts and binaries

There are no included scripts.

Release notes

These are the improvements packaged as part of version 1.2.1. * Minor fixes to get this app certified by Splunk * Added Demo & Tutorial dashboard

These are the improvements packaged as part of version 1.2.0. * Widgets are rearranged in such a way that Metadata Overview tab lists the widgets for all traffic types such as SSL, DNS, HTTP and HTTPS * Advanced metadata details for DNS, SSL and HTTP/HTTPS are put under Metadata Dashboards tab * Shanon Entropy values are calculated for URL Domains and DNS Domains * Some of the new widgets added are: TLS Versions seen, List of DNS Servers Seen, SSL Certificate Heatmap, Self Signed Certificates, SSL Certificates which expired or expiring soon and more

These are the improvements packaged as part of version 1.1.0.

  • New Feature

    • Support for the new metadata elements (GigaVUE-OS 5.1)
  • Bug

    • Fixed URL details panel

About this release

Version 1.2.1 of Gigamon Metadata Application For Splunk is compatible with:

Item Value
Splunk Enterprise versions 6.5, 6.6, 7.0.0, 7.1.1, 8.x.x
Splunk Stream versions 7.0.1, 7.1.x
URL Toolbox 1.6
CIM 4.9
Platforms <Platform independent>
Vendor Products GigaVUE-OS >=5.3 with GigaSMART

NOTE:

Gigamon Metadata Application For Splunk requires Splunk Stream 7.0.1 or 7.1.x to ingest IPFIX data. It is not compatible with Splunk Stream 7.2.x and 7.3.x.
Splunk Stream is not required to ingest CEF data.

New features

Gigamon Metadata Application For Splunk includes the following new features:

  • Ability to parse Gigamon IANA PEN Elements sent via Netflow v10 (IPFIX) from a GigaSMART.
  • Ability to parse CEF data from a GigaSMART.

Fixed issues

Version 1.2.1 of Gigamon Metadata Application For Splunk fixes the following issues:

  • No Fixed Issues. If you find an error, please contact support.

Known issues

Version 1.2.1 of Gigamon Metadata Application For Splunk has the following known issues:

  • When upgrading between Splunk Stream versions:
    • the splunk_app_stream vocabulary file will be deleted. This needs restored with the correct version of the vocab.
    • the splunk_app_stream stream file will be deleted. This needs restored with the correct version of the stream.
    • the change in streams (metadata vs packet) requires the deletion and re-addition of the configured netflow stream.
    • follow the instructions listed under ##### Install into Stream ::install_stream_manual:: to restore correct vocabulary files.
  • If the netflow stream file is changed, any existing streams using that stream configuration need to be deleted and re-added.

Support and resources

Questions and answers

Access questions and answers specific to Gigamon Metadata Application For Splunk at https://answers.splunk.com.

Support

Support Email: apps@gigamon.com
Please visit https://answers.splunk.com, and ask your question regarding Gigamon Metadata Application For Splunk. Please tag your question with the correct App Tag, and your question will be attended to.

INSTALLATION AND CONFIGURATION

Splunk Enterprise system requirements

Because this add-on runs on Splunk Enterprise, all of the Splunk Enterprise system requirements apply.

Because this add-on requires Splunk Stream, all of the Splunk Stream system requirements apply.

Download

Download Gigamon Metadata Application For Splunk at Splunkbase.

https://splunkbase.splunk.com/app/3908/

Installation steps

Deploy to single server instance

Follow these steps to install the app in a single server instance of Splunk Enterprise:

  1. Download the Gigamon Metadata Application For Splunk package from https://splunkbase.splunk.com.
  2. Install the App via the recommended installation methods (CLI, Web GUI)
  3. Restart Splunk.
  4. See the Instructions for Gigamon and Stream Integration.

Install Splunk App URL Toolbox

Gigamon Metadata Application For Splunk has dependency on the app “URL Toolbox”. Install the Splunk app “URL Toolbox” using the standard installation procedure. “URL Toolbox” can be found on splunkbase.splunk.com.

Steps to Ingest CEF Data

  1. Edit $SPLUNK_HOME/etc/apps/GigamonMetadataForSplunk/appserver/static/library/gigamon_cef_inputs.conf to change the receiver port to your local settings (replace PORT).
  2. Copy gigamon_cef_inputs.conf to $SPLUNK_HOME/etc/apps/GigamonMetadataForSplunk/inputs.conf

Here is an example output of inputs.conf file
[udp://10514]
connection_host = ip
sourcetype = cefevents

10514 above is the port number. Change it to whatever the port number desired. Make sure that it matches with port number configuration on GigaSMART device.

Gigamon and Stream Integration ::gsi::

The Gigamon and Stream integration requires precise adherence to the instructions. Failure to do so may cause Stream to not collect the Gigamon IPFIX data appropriately.

The GSI (Gigamon and Stream Integration) is an advanced configuration technique, designed to extend the protocol decoding abilities of Splunk Stream. As this feature relies on Splunk Stream, Splunk Stream is a requirement and must be installed on your Splunk server(s). Please see the instructions on how to install Splunk Stream.

Install Stream ::ss_install::

If you are installing Stream for the first time, the preferred version at this time is 7.1.0. If you have an existing stream installation, ensure the version number is 7.0.1 or 7.1.0 (other versions, if available, have not been tested).

NOTE: The NIC associated with the Netflow collection should not be in promiscuous mode. Stream is being used as a protocol decoder in this configuration only.

Extend Stream

In order to extend the base installation of Stream, there must be file-level changes made. This is a Manual Configuration. The base location of the Gigamon-specific configuration is $SPLUNK_HOME/etc/apps/GigamonMetadaForSplunk/appserver/static/library. $SPLUNK_HOME refers to the install location of Splunk. Start in the library folder mentioned, and then proceed to either Manual Configuration.

Manual Configuration ::install_manual::

This configuration method requires the user to edit and copy various files to locations in the splunk_app_stream and Splunk_TA_stream apps. $SPLUNK_HOME refers to the install location of Splunk.

Install into Stream ::install_stream_manual::
  1. Edit $SPLUNK_HOME/etc/apps/GigamonMetadaForSplunk/appserver/static/library/gigamon_streamfwd.conf to change the reciever IP and Port to your local settings (replace @@IP and @@PORT).
  2. Copy $SPLUNK_HOME/etc/apps/GigamonMetadaForSplunk/appserver/static/library/gigamon_streamfwd.conf to $SPLUNK_HOME/etc/apps/splunk_app_stream/local/streamfwd.conf and $SPLUNK_HOME/etc/apps/Splunk_TA_stream/local/streamfwd.conf

Open up the File and modify the gigamon_vocabulary file to match the version of the Splunk Stream.

Eg: IF you are using Splunk Stream 7.1.3

Replace this line : <CmConfig xmlns="<a href="http://purl.org/cloudmeter/config">http://purl.org/cloudmeter/config" version="7.1.1">

With : <CmConfig xmlns="<a href="http://purl.org/cloudmeter/config">http://purl.org/cloudmeter/config" version="7.1.3">

  1. Copy the Splunk Stream Version-specific vocabulary file (see file names right below) to $SPLUNK_HOME/etc/apps/splunk_app_stream/default/vocabularies/gigamon.xml and $SPLUNK_HOME/etc/apps/Splunk_TA_stream/default/vocabularies/gigamon.xml.

  2. Copy $SPLUNK_HOME/etc/apps/GigamonMetadaForSplunk/appserver/static/library/gigamon_stream.json to $SPLUNK_HOME/etc/apps/splunk_app_stream/default/streams/netflow.

  3. GigaSMART occasionally sends data elements encoded in ASN.1 to Stream. To avoid excessive license usage, apply the following fix.
    1. On the system indexing the Stream data (typically where splunk_app_stream is installed), edit the $SPLUNK_HOME/etc/apps/splunk_app_stream/local/props.conf file.
    2. For the stanza [stream:netflow], add this line of configuration: SEDCMD-remove_nulls_gigamon = s/\\u0000//g. If the stanza doesn't exist, create it.
    3. This SEDCMD will remove any data that cannot be decoded correctly.
  4. Restart Splunk.
  5. Configure Stream via the steps at Stream Configuration.

Stream Configuration ::stream_config::

Full and complete documentation of Stream Configuration is located at docs.splunk.com. This instructions use Stream 7.1.0 as the basis, but instructions for Stream 7.0.1 are available as well at Stream 7.0.1 - User Manual - Configure Streams.

  1. On the Splunk Home page, click on the app “Splunk Stream”
  2. Use the navigation bar: Configuration -> Configure Streams
  3. In the top right of the dashboard, click New Stream -> Metadata Stream
    1. ( Full Documentation here)
  4. Basic Info
    1. Protocol: Netflow
    2. Name: your source name
    3. Click Next
  5. Aggregation ( Full documentation here)
    1. Click Next to accept the default of No
  6. Fields ( Full documentation here)
    1. Deselect the fields that you do not want to collect
    2. Click Next
  7. Filters ( Full documentation here)
    1. Create a filter to limit the data that is collected
    2. Click Next
  8. Settings
    1. Select an index to collect data to
    2. Select the status
    3. Click Next
  9. Groups
    1. Select a forwarder group (if applicable)
    2. Click Create Stream
  10. Done
    1. Click Done

Configure GigaSMART

Now that Stream is configured to accept Gigamon Elements, configure the Gigamon appliance that has the GigaSMART card installed. Gigamon provides documentation to configure netflow and metadata generation, and there is also a third-party step-by-step tutorial that may help configure the GigaSMART.

NOTE: There is an option within the GigaSMART Exporter configuration to set the Template Refresh Interval. This setting should be set to AT MOST 2 minutes.

Distributed Stream Deployment

If you are pushing Splunk_TA_stream to a universal forwarder in a distributed deployment, then you must make the same changes for Splunk_TA_stream above in the deployment-apps folder

Stream Upgrade Notes

  • When upgrading Stream:

    • the splunk_app_stream vocabulary file will be deleted. This needs restored with the correct version of the vocab.
      • Follow Step 3 in the Manual Configuration.
    • the splunk_app_stream stream file will be deleted. This needs restored with the correct version of the stream.
      • Follow Step 4 in the Manual Configuration.
    • the change in streams (metadata vs packet) [Splunk Stream 7.0.1 -> 7.1.x] requires the deletion and re-addition of the configured netflow stream.
  • If the netflow stream file is changed, any existing streams using that stream configuration need to be deleted and re-added.

USER GUIDE

Data types

This app provides the index-time and search-time knowledge for the following types of data:

  1. Gigamon IANA PEN Elements as sent via GigaSMART over Netflow IPFIX.

Lookups

The following lookups are provided as a part of the Gigamon Metadata Application For Splunk app.

  • port_list
    • This lookup provides descriptions for most common port numbers.
  • http_status
    • This lookup provides descriptions for most HTTP event codes.
  • dns_responses
    • This lookup provides descriptions for DNS reply code ids.
  • protocol_numbers
    • This lookup provides descriptions for most common protocol numbers.
  • dns_server_list
    • This lookup provides Trusted and Known DNS server IP address. User can edit this file $SPLUNK_HOME/etc/apps/GigamonMetadataForSplunk/lookups/dns_server_list.csv to add list of DNS servers known to the organization.
  • http_standard_ports
    • This lookup provides Standard ports for HTTP and HTTPS. User can edit this file $SPLUNK_HOME/etc/apps/GigamonMetadataForSplunk/lookups/ http_standard_ports.csv to add their custom standard HTTP/HTTPS ports.
  • dns_standard_ports
    • This lookup provides Standard ports for DNS. User can edit this file $SPLUNK_HOME/etc/apps/GigamonMetadataForSplunk/lookups/ dns_standard_ports.csv to add their custom standard DNS port other than 53.
      If lookup files are edited, reload Splunk to make new changes take effect.

Event Generator

Gigamon Metadata Application For Splunk does make use of an event generator. This allows the product to display data, even when there are no inputs configured. Edit eventgen.conf for each stanza to "enable" the stanza.

gigamon_ipfix_http.sample

This generates relevant fields to the IPFIX IANA HTTP elements.

gigamon_ipfix_ssl.sample

This generates relevant fields to the IPFIX IANA SSL elements.

gigamon_ipfix_dns.sample

This generates relevant fields to the IPFIX IANA DNS elements.

Configure Gigamon Metadata Application For Splunk

  • Install the App according to your environment (see steps above)
  • Navigate to the App
  • Edit the event type to point to the correct data for the netflow.
  • Click the Update Eventtype button, and the Save button.

Troubleshoot Gigamon Metadata Application For Splunk

The best place to start troubleshooting Gigamon Metadata Application For Splunk is to visit the Monitoring Console Health Check. There are 4 specific checks related to the Gigamon Stream configuration.
Click the "Start" button and then review the results.

If you are still having problems, use the Command line and run this command:

$SPLUNK_HOME/bin/splunk diag --collect app:GigamonMetadaForSplunk

Send the generated diag file to Gigamon Metadata Application For Splunk support.

Accelerations

Summary Indexing: None
Data Model Acceleration: None
Report Acceleration: None

Upgrade Gigamon Metadata Application For Splunk

Upgrade Gigamon Metadata Application For Splunk by re-installing into your environment per Splunk Documentation and your environment (see steps above).

Third-party software attributions

Gigamon Metadata Application For Splunk incorporates the third-party software or libraries referred at the path $SPLUNK_HOME/etc/apps/GigamonMetadaForSplunk/appserver/static/html/3pp.md

Release Notes

Version 1.2.1
June 4, 2018

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.