Skip to content

Arguments

Usage: ixpect [OPTIONS]

Ixpect allows to pass options via CLI arguments and environment variables, with arguments taking precedence.

Options#

  • -c <CONFIG> | --config <CONFIG>
    Configuration file to use
    Default: /etc/ixpect/ixpect.conf.yaml

  • -t <TEMPLATE_DIR> | --template-dir <TEMPLATE_DIR>
    Template directory used by notifiers to format event notifications
    Default: /etc/ixpect/templates

  • -r <REDIS_URL> | --redis-url <REDIS_URL>
    Redis URL required for dynamic records of various probes
    Default: redis://[::1]:6379

  • -n <CAPTURE_NETNS> | --capture-netns <CAPTURE_NETNS>
    Network namespace to be used for packet capturing

  • -i <CAPTURE_INTERFACE> | --capture-interface <CAPTURE_INTERFACE>
    Name of the interface where packets should be captured

  • --pcap-file <PCAP_FILE>
    File containing a packet capture which should be processed

  • --pcap-decap <PCAP_DECAP>
    Do tunnel decapsulation on captured packets
    Enum:

    • none (default)

    • vxlan

  • --vxlan-netns <VXLAN_NETNS>
    None

  • --vxlan-listen-addr <VXLAN_LISTEN_ADDR>
    Listen address of the VxLAN socket

  • --vxlan-vni <VXLAN_VNI>
    The VNI of VxLAN packets which should be processed, packets with other VNIs will be ignored

  • -p <PACKET_POOL_SIZE> | --packet-pool-size <PACKET_POOL_SIZE>
    Number of packets that can be buffered and processed in parallel
    Default: 32

  • -u <USER> | --user <USER>
    Change UID to a dedicated (less privileged) user after setting up the packet source

  • IXPECT_CONFIG=<CONFIG>
    Configuration file to use
    Default: /etc/ixpect/ixpect.conf.yaml

  • IXPECT_TEMPLATE_DIR=<TEMPLATE_DIR>
    Template directory used by notifiers to format event notifications
    Default: /etc/ixpect/templates

  • IXPECT_REDIS_URL=<REDIS_URL>
    Redis URL required for dynamic records of various probes
    Default: redis://[::1]:6379

  • IXPECT_CAPTURE_NETNS=<CAPTURE_NETNS>
    Network namespace to be used for packet capturing

  • IXPECT_CAPTURE_INTERFACE=<CAPTURE_INTERFACE>
    Name of the interface where packets should be captured

  • IXPECT_PCAP_FILE=<PCAP_FILE>
    File containing a packet capture which should be processed

  • IXPECT_PCAP_DECAP=<PCAP_DECAP>
    Do tunnel decapsulation on captured packets
    Enum:

    • none (default)

    • vxlan

  • IXPECT_VXLAN_NETNS=<VXLAN_NETNS>
    None

  • IXPECT_VXLAN_LISTEN_ADDR=<VXLAN_LISTEN_ADDR>
    Listen address of the VxLAN socket

  • IXPECT_VXLAN_VNI=<VXLAN_VNI>
    The VNI of VxLAN packets which should be processed, packets with other VNIs will be ignored

  • IXPECT_PACKET_POOL_SIZE=<PACKET_POOL_SIZE>
    Number of packets that can be buffered and processed in parallel
    Default: 32

  • IXPECT_USER=<USER>
    Change UID to a dedicated (less privileged) user after setting up the packet source

Privileges#

IXpect requires root permissions to change into network namespace (optional), set up BPF filters and capture packets on a network interface. After this initial phase, IXpect can change its UID to the user specified via the --user command-line argument.