16 CLI - command line interface

The fdpi_cli utility allows you to view and manage the contents of the internal fastDPI and fastPCRF structures.

The utility is Beta. Some commands output a lot of data, up to tens of thousands of records. It is not recommended to call such commands in the peak hours.

Utility activation:

fdpi_cli [-r <address>] [<options>] <command>
<address> - fastdpi or fastpcrf server address in format: ip%dev[:port]
e.g., 10.20.30.40%eth1, 127.0.0.1%lo.
Default ports: fastdpi=29000, fastpcrf=29002
Default address 127.0.0.1
<options>:
-h, --help - displays utility help
-t N - server response timeout, seconds; default - 5 seconds
-v - verbose output: -v, -vv, -vvv, -vvvv
--json - responses output in JSON format
--strict - use strict JSON (quoted field name). Only relevant for --json
<command> - command fdpi_cli
Quick help for all fdpi_cli commands:
fdpi_cli help
Detailed help for a specific command:
fdpi_cli help <command>

The verbosity is intended for fdpi_cli debugging purposes and does not affect the output of the command itself.

By default, the CLI assumes that fastdpi and fastpcrf are on the same server from which the CLI is called. If the -r argument is not specified, -r 127.0.0.1 is assumed. If fastdpi or fastpcrf are on a remote machine, you have to specify -r argument - fastdpi or fastpcrf-server address. We recommend making alias for fdpi_cli for each of the possible addresses; for example, alias for CLI fastpcrf server 10.20.30.40: alias fpcrf_cli="fdpi_cli -r 10.20.30.40"
Security: DPI accepts CLI commands from any source. For security reasons, we recommend restricting access to control TCP ports 29000 (fastdpi) and 29002 (fastpcrf) only to trusted clients using the linux firewall (iptables).

Commands fdpi_cli:

DHCP - view and management of DHCP fastdpi BRAS database

DHCPv6 - view and management of the internal DHCPv6 fastdpi BRAS database

PPPoE - view and management of the internal PPPoE-sessions fastdpi BRAS database

GTP - view and management of the internal GTP-sessions database

subscribers - subscribers management

accounting - view and management of the internal accounting fastpcrf database

PCRF - fastpcrf management

vlan translation - VLAN translation management