.. _CliOptions:

Agent Configuration
-------------------

nProbe Agent supports a few options (command line parameters), to see an updated list please simply enter the command :code:`nprobe-agent -h`. Example:

.. code:: bash

   -h                          | Print this help
   -v                          | Verbose output
   [-z|--zmq <option>]         | Specify the ZMQ endpoint to which JSON data will be delivered
   [-k|--kafka <broker>,<topic>]
			       | Exports flows to the specified Kafka <topic>, using the list of
			       | brokers retrieved from the metadata obtained from <broker>
   -e                          | Disable eBPF polling
   -n                          | Disable Netlink polling
   -l                          | Discard loopback information
   -L                          | Discard listening sockets
   [-V|--version]              | Display probe version
   [-C|--check-license]        | Checks if the license is present and valid
   [-M|--check-maintenance]    | Checks the maintenance status

The most important parameters are briefly discussed in the sections below.

ZMQ Export
==========

:code:`-z|--zmq <socket>`

      Specify an endpoint (e.g., :code:`tcp://\*:5556`) that will be used to deliver flows to subscribers polling the socket. Example:

      .. code:: bash

	 nprobe-agent --zmq tcp://\*:5556

      ntopng can be used to analyze the flows generated by nProbe Agent in JSON format through ZMQ.
      When used with ntopng, nProbe Agent can act as a remote and light probe and ntopng as a central
      network monitoring console. Example:

      .. code:: bash

	 ntopng -i tcp://*:1234c -m "192.168.2.0/24"

Kafka Export
============

:code:`-k|--kafka <broker>,<topic>`

      Export data to the specified Kafka :code:`<topic>`. The list of brokers
      which will be used for the export is obtained from the metadata
      retrieved from :code:`<broker>`.

      Currently, eBPF and Netlink data is exported to the same
      :code:`<topic>`.

      Assuming a topic named :code:`test` is available through a
      broker on :code:`127.0.0.1:9092`, one can use the following configuration

      .. code:: bash

	 nprobe-agent -k 127.0.0.1:9092,test

Working Mode
============

:code:`-e`

      Disables eBPF polling. eBPF provides information about traffic flows (creation, deletion, and updates).
      This includes accept/connect/connection-failed/close/retransmit events for TCP, send/recv for UDP.
      Admin rights (root) are required in order to run eBPF.

:code:`-n`

      Disables Netlink polling. Netlink provides periodic network status information (e.g. established connections) and traffic statistics on interfaces.

:code:`-l`

      Discards information for the loopback interface.

:code:`-L`

      Discards information for listening sockets.

License
=======

:code:`--check-license`

      Checks if the configured license is valid.

:code:`--check-maintenance`

      Checks if the configured license is valid and shows maintenance information.

:code:`-V|--version`

      This flag is used to print the nProbe Agent version number and date, as well as other information.

Misc
====

:code:`-v`

      Using this flag, nProbe Agent generates verbose output.

:code:`-h: print help`

      Prints the nProbe Agent help.