====== Output of control commands using the JSON format ======
{{indexmenu_n>11}}

To simplify parsing command output when integrating with external platforms and web applications, ''fdpi_ctrl'' supports JSON output.

To enable JSON output, specify the following additional command-line parameter:
<code bash>--outformat json</code>

For convenient JSON processing, we recommend installing the ''jq'' utility:
<code bash>
yum install epel-release
yum-config-manager --disable epel
yum --enablerepo epel install jq
</code>

Examples:

  - Pretty-print the command output: <code bash>fdpi_ctrl list all profile --policing --outformat json | jq .</code>
  - Display statistics for different policing profiles: <code bash>fdpi_ctrl list all --policing --outformat json | jq '.lpolicings[].description.name' | sort | uniq -c</code> or produce the same statistics in JSON format using ''jq'': <code bash>fdpi_ctrl list all --policing --outformat json | jq '[{ name: .lpolicings[].description.name, login: .login }] | group_by(.name) | .[] | { name: .[0].name, count: . | length }'</code>
  - For repeated use, this command can be wrapped in a Bash function: <code bash>function fdpi_policing_stat() { fdpi_ctrl list all --policing --outformat json | jq '[{ name: .lpolicings[].description.name, login: .login }] | group_by(.name) | .[] | { name: .[0].name, count: . | length }'; }</code> and then simply invoked from the command line: <code bash>fdpi_policing_stat</code>

To make such functions permanently available, save them in the ''.bash_profile'' file.