Available Commands

The list of commands in the following table contains either standard Linux commands or custom commands which can be used by the flowmon user and can help with the maintenance and troubleshooting of the Flowmon solution. You can execute the commands in the CLI which is accessible over SSH or through the local console. Command arguments that should be provided by the user to perform the required action are marked with < and >.

Command	Description
/home/flowmon/restore_factory_settings.sh	Resets the FMC and FCC to the default configuration, puts back the default SSL certificate, and deletes all collected data, reports, and active devices database. Cleans data of all modules, resets admin GUI password to the default value, deletes logs and GUI cache, and resets network interfaces to default. Without arguments, the command runs in an interactive mode and asks you to confirm individual actions.
/home/flowmon/restore_factory_settings.sh autorun	Executes the above function to reset the appliance to the default configuration but it answers Yes automatically to all questions and it only keeps the network configuration intact.
/usr/local/bin/sysconfig	Opens an interactive menu to set up IP addresses of the management interfaces, gateway, DNS servers, hostname, date and time options, and password for SSH access.
/usr/bin/php /var/www/shtml/index.php Cli:AddUser -login="<username>" -pass="<password>" -name="<name>" -surname="<surname>" -email="<email>" -role="<role>"	Creates new Flowmon users from the CLI with the selected parameters.
/usr/bin/php /var/www/shtml/index.php Cli:DeleteUser -login="<username>"	Deletes a Flowmon user specified by \<username>.
/usr/bin/php /var/www/shtml/index.php Cli:ChangePassword -login="<username>" -pass="<password>"	Sets \<password> as the password for the existing Flowmon user \<username>\.
curl https://<ip>/fcc/system/getconfigsections/	By using cURL or your browser, you will find all available sections for Get and Set ConfigurationXML as described below. It is then used with parameter -section=. For example -section=cfg_ads_filters to get or set only ADS Filters configuration.
/usr/bin/php /var/www/shtml/index.php Cli:GetConfigurationXML > /home/flowmon/config.xml	Retrieves the full system configuration and stores it in the /home/flowmon/config.xml file. Using parameters, it is possible to retrieve only a particular section of the configuration. To get all the sections, check the command above.
/usr/bin/php /var/www/shtml/index.php Cli:SetConfigurationXML -method="delete" -xml="/home/flowmon/config.xml"	Restores system configuration with all available details from /home/flowmon/config.xml. Using the delete method replaces all existing configurations with the one stored in the provided XML file. The other option is to use the method “add” which is the equivalent of Add and Modify import from the UI.
/usr/bin/php /var/www/shtml/index.php Cli:InstallPackage -package=<package_name>	Initiates installation of the Flowmon OS package specified in the parameter \<package_name>. If Distributed Architecture (DA) is enabled, the distributed update is started. The package must be in the /tmp directory. It only returns a successful message or an error.
cat /etc/flowmon/pkg_versions.txt	Displays versions of installed packages.
cat /etc/flowmon/hwplatform.php	Provides details about memory and the HW ID needed for the license.
sudo /usr/local/bin/gather-logs.sh	Generates an archive with appliance logs for Flowmon Support. The created file named “logs-DATE-TIME.tar.gz.gpg” is stored in /home/flowmon. Its content is already compressed and encrypted using PGP. It is normal for this command to run for a couple of minutes. The produced file may have hundreds of MBs depending on the log size.
sudo killall -HUP httpd` or `sudo systemctl restart httpd	Restarts the HTTP daemon (Apache).
sudo service postgresql restart	Restarts the PostgreSQL database.
systemctl status postgresql	Shows the status of the PostgreSQL database.
sudo /usr/sbin/SHC/self-health-checker.sh	Runs the self-health check script to check the system’s critical functions. The self-health check script is described in an independent section of this document. This was added in Flowmon version 8.03.
sudo /opt/snf/sbin/myri_mdio_rw -b<num>	Checks the light levels on 10G SFPs from Myricom. \<num> is a number from 0 to 3, where 0 is the first port on the first card and 3 is the last port on the second card - in the case of the IFP-40000-SFP+ model. This works only with Flowmon Probes using Myricom cards (10G Flowmon Probes sold until 10/2020).
sudo shutdown	Shuts down the appliance.
sudo /etc/init.d/nfsen [start\|stop\|restart\|status\|reload\|reconfig]]	This command checks the status, starts, or restarts the nfsen daemon (the FMC function to capture flows and perform analysis). Nfsen will restart automatically if stopped by this command.
/usr/bin/php /var/www/shtml/index.php Cli:fmcController -a=[start\|stop]	Starts or stops the nfsen daemon. This command emulates the collector start/stop trigger from the user interface. Nfsen remains stopped until it is manually started with the same command.
sudo ethtool <intf>	Gets the status and supported modes of the interface specified by \<intf>.
sudo route -n	Shows the appliance's routing table. For more details, check the manual page.
man <command>	Shows the manual page for certain commands or system functions.
sudo tail -n 10 /var/log/daemon	Checks n lines of the daemon log or any other file located in the /var/log directory.
ip address	Provides a list of IP addresses assigned to all interfaces of the appliance.
sudo /opt/dell/srvadmin/sbin/racadm raid get pdisks -o -p status,state	Checks the status of disks in the RAID. This is only applicable for hardware appliances.
sudo /opt/dell/srvadmin/sbin/racadm raid get vdisks -o -p layout,status	Checks the status of a virtual disk. This is only applicable for hardware appliances.
sudo /usr/local/bin/disk_consistency_check.pl -r	Starts the disk consistency check after reboot.
sudo /usr/sbin/flowmon <start\|stop\|status\|restart> [portID]	Performs an action (start, stop, status...) on all exporters or an exporter on a specific port. Monitoring port 1 has ID 1, and so on.
/usr/local/bin/nfdump -r /data/nfsen/profiles-data/live/127-0-0-1_p3000/nfcapd.current	Checks a specific nfcapd file containing received flow data. This command checks the file associated with a collector listening on localhost, port 3000. The nfcapd.current file is a file used to store the currently arriving data. More information is in the manual page of the command.
systemctl status spec-melt-vulnerability.service	Shows the status of Meltdown & Spectre mitigation features. For details, refer to the [Meltdown & Spectre](./Meltdown-&-Spectre.md) section below.
	Introduced in Flowmon version 11.0.1.
sudo systemctl <start\|stop\|enable\|disable> spec-melt-vulnerability.service	Controls Meltdown & Spectre mitigation features. For details, please refer to the [Meltdown & Spectre](./Meltdown-&-Spectre.md) section below.
	Introduced in Flowmon version 11.0.1.
sudo backup -i	Shows the status of Disaster Recovery backups. For details, refer to the [Backup for Disaster Recovery](./Backup-for-Disaster-Recovery.md) section below.
	Introduced in Flowmon version 11.0.5.
sudo backup -l	Lists available Disaster Recovery backups. For details, refer to the [Backup for Disaster Recovery](./Backup-for-Disaster-Recovery.md) section below. Introduced in Flowmon version 11.0.5.
sudo backup -c	Applies changes from the backup.yml configuration file. For details, refer to the [Backup for Disaster Recovery](./Backup-for-Disaster-Recovery.md) section below.
	Introduced in Flowmon version 11.0.5.
sudo backup -b	Creates a Disaster Recovery backup of the appliance. For details, refer to the [Backup for Disaster Recovery](./Backup-for-Disaster-Recovery.md) section below.
	Introduced in Flowmon version 11.0.5.
sudo backup -r <backup_name>	Recovers the appliance state from the selected Disaster Recovery backup. For details, refer to the [Backup for Disaster Recovery](./Backup-for-Disaster-Recovery.md) section below.
fqa <start\|startd\|stop> [udp_port] [collection_time] [max_used_disk_space_mb]	Starts, starts detached, or stops the flow quality analysis for a specific UDP listening port on the Collector. Returns results in either a plain text format or a more detailed JSON file for automated processing. The analysis stops after the specified time or when the maximum used disk space is reached - whichever comes first.
	Introduced in Flowmon version 12.0.
/usr/local/bin/ipsec-nat.sh -a SOURCE:DESTINATION	Creates a new SNAT rule for SOURCE:DESTINATION.
	Introduced in Flowmon version 12.3.0.
/usr/local/bin/ipsec-nat.sh -d SOURCE:DESTINATION	Deletes a SNAT rule for SOURCE:DESTINATION.
	Introduced in Flowmon version 12.3.0.
/usr/local/bin/ipsec-nat.sh -l	Lists all SNAT rules.
	Introduced in Flowmon version 12.3.0.
/usr/local/bin/ipsec-nat.sh -c	Removes all SNAT rules.
	Introduced in Flowmon version 12.3.0.