Interactive Mode command list¶

The following commands and their directives can be used once connected to the Plixer Replicator in Interactive Mode and at the REPLICATOR> prompt.

Hint

For assistance while in Interactive Mode, enter command help, help <command>, <command> ?, or ? at any time.

acknowledge¶

Function	Sets the status of an unavailable Exporter or Collector as acknowledged and stops the Plixer Replicator from sending additional notifcations about the resource being down
Syntax	acknowledge <exporter\|collector> [ip_address:port] REPLICATOR> acknowledge exporter 10.1.1.2 REPLICATOR> acknowledge collector 10.1.1.1:2055

backup¶

Function	Creates a backup of the Plixer Replicator database in `/home/replicator/backups/`. Backup filenames cannot contain spaces. See also: restore, show
Syntax	backup [filename] REPLICATOR> backup replicator_backup

collect supportfiles¶

Function	Gathers all relevant logs and configuration files and compresses them into a tar.gz file in the `/home/replicator/supportfiles` directory
Syntax	collect supportfiles REPLICATOR> collect supportfiles

collector¶

Function	Adds or removes a Collector from a Profile
Syntax	collector <add\|remove> [collector_ip] [profile_name] REPLICATOR> collector add 10.1.1.1 maineStreet REPLICATOR> collector remove 10.1.1.1 maineStreet
Directives	allremove [collector_ip] - Removes the Collector from all Profiles threshold [collector_ip] [limit] - Sets the maximum packets/second for the Collector REPLICATOR> collector allremove 10.1.1.1 REPLICATOR> collector threshold 10.1.1.1 100000

exporter¶

Function

Adds or removes a Collector from a Profile

Syntax

exporter <add|remove> [exporter_ip] [profile]

REPLICATOR> exporter add 10.1.1.2 maineStreet
REPLICATOR> exporter remove 10.1.1.2 maineStreet

Directives

allremove [exporter_ip] - Removes the Exporter from all Profiles
noprofile - Returns a list of all Exporters not currently assigned to any Profile

REPLICATOR> exporter allremove 10.1.1.2
REPLICATOR> exporters noprofile

+--------------------------------------------------------------------------+
| 10.1.73.1         Fri Nov 15 13:48:52 2019         1 packet(s)
| 10.1.29.60        Fri Nov 15 13:48:52 2019         2 packet(s)
| 10.202.0.103      Fri Nov 15 13:48:52 2019         5 packet(s)
| 10.200.10.1       Fri Nov 15 13:48:52 2019        32 packet(s)
| 172.20.124.41     Fri Nov 15 13:48:52 2019         1 packet(s)
+--------------------------------------------------------------------------+
Done in 0.035998 secs

It is recommended for unassigned Exporters to either be added to a Profile or configured to stop sending packets to the Plixer Replicator.

Note

It is normal for Exporters that export data infrequently to be listed with 0 packets.

ldapadmin¶

Function	Sets the admin password for LDAP configuration
Syntax	ldapadmin, ldapadminpass (alternative) REPLICATOR> ldapadmin REPLICATOR> ldapadminpass

license¶

Function

Checks the status of the currently active license key or applies a new license key

To generate a license key, Plixer or the reseller will need the Plixer Replicator’s unique machine ID. The machine ID is displayed when issuing the license check command:

Syntax

license <check|status> - Returns the details of the currently applied license key
license <set|update> - Opens a popup for the user to enter a new license key

REPLICATOR> license check

Machine ID : 6YZ6XEPT66FPH6364A1VQ8NY
Customer ID : austin replicator
Licensed Version : 18.5
Licensed Type : subscription (standalone/primary)
Expiration : 11/30/2020

REPLICATOR> license set

[replicator]
engine=pg
dbname=/home/replicator/html/db/replicator.db
user=
pass=
license=Nb7RuYhxJWxUv9u+nTdHCnRj5R9EiXQv5qDS9WO41jC4XBBYkErNZ6Q+Oi+Q+6uGwfaQJZO6QzE3wjgWsf2CfqlCp3SdO5/txz6yhFurK7Cz4Js1kuraTt96Q1pRru9zCk5gUxbNjISzI3BlY75eMMDddTFv2XKJRxzDe8CK8N1Ov4Okkod1gx9tWW2xFToAJmTyYXGYgIWGFhWOrPTvCB+t1j3kuqnaf/HgVYMahQgDjPHhbuq2ft2HA1iuhRZU2q0Bt8TbSy+6CmvKLe7tSqht5V9bSLYQSdaJ1/gntqAJaa4dGG4fBGmDgK30zLkC+OEFm402axzCmQ==

Important

To generate a license key, Plixer or the reseller will need the Plixer Replicator’s unique machine ID displayed when entering the license check command. The license key must be entered in the popup as a single continuous string with no line feeds or carriage returns.

Hint

Both the license check and show status comands can be used to verify that a license key has been properly applied. Contact technical support to obtain a new license key.

notate¶

Function	Adds a description or note that will be displayed in various reports to a Profile or IP address
Syntax	notate profile [profile_name] [description] - Adds a description to the Profile notate ip [ip_address] [description] - Adds a description to an IP address REPLICATOR> notate profile maineStreet A fun and happy place REPLICATOR> notate ip 10.1.1.2 my awesome router

password¶

Function	Sets the login password for the Plixer Replicator web interface or Interactive Mode. The new password will be applied when the user next logs in
Syntax	password <interactive\|webui> - Returns a prompt for the user to enter a new password REPLICATOR> password interactive (current) UNIX password: New password: Retype new password:

Important

To successfully change the Interactive Mode password, the user must first enter the current, i.e. UNIX password.

policy¶

Function	Adds a Policy to the Profile that automatically includes or excludes the Exporters that match the provided subnet/CIDR When the appliance receives a packet, include policies are checked beforeexclude policies.
Syntax	policy <add\|remove> [subnet/cidr] [profile] <include\|exclude> - Adds or removes the Policy from the Profile REPLICATOR> policy add 192.168.0.0/16 maineStreet include REPLICATOR> policy add 192.168.2.0/24 maineStreet exclude REPLICATOR> policy remove 192.168.2.0/24 maineStreet

Important

A Policy must be entered in the subnet/CIDR notation.

profile¶

Function	Adds or updates a Profile and manages other Profile-related settings
Syntax	profile <add\|update> [profile_name] [in_port] [out_port] REPLICATOR> profile add maineStreet 2002 2055 REPLICATOR> profile update maineStreet 2003 2056
Directives	profile <remove\|disable\|enable> [profile_name] - Removes, disables, or enables the Profile profile rename [old_name] [new_name] - Renames the Profile profile singularity [profile_name] <enable\|disable> - Enables or disables replication using the Plixer Replicator’s IP instead of Exporters’ (default: disabled) REPLICATOR> profile remove maineStreet REPLICATOR> profile disable maineStreet REPLICATOR> profile enable maineStreet REPLICATOR> profile rename maineStreet streetOfMaine REPLICATOR> profile singularity maineStreet enable REPLICATOR> profile singularity maineStreet disable

rebuild¶

Function	Used to rewrite the internal configuration of the Plixer Replicator when replication services are down and issues are otherwise unresolvable The sampcfg command is an alias for the rebuild command.
Syntax	rebuild, sampcfg (alias) REPLICATOR> rebuild

restore¶

Function	Restores a database backup from files in `/home/replicator/backups`
Syntax	restore [filename] REPLICATOR> restore backup20210214

Important

Restore also reverts to the same version of PostgreSQL that was in use when the backup file was created.

role¶

Function

Assigns roles to individual appliances in configurations using multiple Plixer Replicators For more information, see the section on fault tolerant deployments.

Syntax

role set ha master [ip_address]
role set ha off
role set ha on [priority] [virtual_ip] [ifname] <master|backup>
role set primary
role set secondary [primary_replicator_ip:listener_port] [timeout]
role test <ha|secondary>

REPLICATOR> role set master <ip_address>
REPLICATOR> role set ha off
REPLICATOR> role set ha on 101 10.1.4.223 eth0 master
REPLICATOR> role set primary
REPLICATOR> role set secondary 10.1.4.66:2002 10
REPLICATOR> role test secondary

setting¶

Function	Configures the Plixer Replicator’s global settings, allowing features to be enabled, disabled, or modified See also: show
Syntax	setting set <flag> [value] setting <enable\|disable> <flag> REPLICATOR> setting set metricsSent 10.1.4.66:2003 REPLICATOR> setting disable convertSyslog

Hint

The Settings tab of the Plixer Replicator web interface can also be used to configure certain global settings.

show¶

Function	Generates various reports based on the Plixer Replicator’s configuration and operational data
Syntax	show [directive] [filter]
Directives	alarm [filter] - Lists Exporters that have stopped sending packets to the Plixer Replicator and COllectors that are no longer reachable asset [filter] - Lists IP addresses associated with the Plixer Replicator along with their roles (Exporter or Collector), DNS names, and descriptions/notes backups [filter] - Lists files in the `home/replicator/backups directory` along with the date they were last accessed show collector [filter] - Lists Collectors along with their IP addresses, DNS names, descriptions/notes, and Profiles they’re currently assigned to show config - Lists all commands necessary to rebuild Profile settings show exporter [filter] - Lists Exporters along with their IP addresses, DNS names, descriptions/notes, and Profiles they’re currently assigned to show profile [filter] - Lists Profiles along with their Policies and any Exporters and/or Collectors currently assigned to them show realtime [filter] - Displays real-time data on Exporters, such as their inbound and outbound traffic and CPU usage (press CTRL+C to exit the report) show setting [filter] - Displays all global settings along with their statuses (enabled or disabled) and/or current values show status - Lists all of the Plixer Replicator’s services and licenses along with their statuses REPLICATOR> show status +--------------------------------------------------------------------------+ \| Version v18.5.24.2345 \| Replicating Port 2055 ACTIVE \| Replicator Vitalizer ACTIVE \| Replicator API ACTIVE \| Replicator Monitor ACTIVE \| Replicator State ACTIVE \| Replicator License License Expires: 380 +--------------------------------------------------------------------------+ + process checking took 0.22578 secs

Hint

Most show commands can also be entered with a filter argument to display only details that match the provided string. When no filter is entered, the full report will be generated.

snoop¶

Function	Displays packet data for a certain address or interface
Syntax	snoop <ip_address> snoop interface <interface_name> <port [port_number]> REPLICATOR> snoop 10.1.1.1 REPLICATOR> snoop eth0

Hint

The snoop command can be used to verify that packets are being received from or sent to the specified IP address.

system¶

Function	Manages the state and certain settings of the Plixer Replicator
Syntax	system <restart\|shutdown> REPLICATOR> system restart REPLICATOR> system shutdown
Directives	change - Changes the host name or the IP address of the appliance virtualip <enable\|disable> <interface_name> [virtual_ip] - Adds or removes a virtual IP address for High Availability (HA) configurations REPLICATOR> system change REPLICATOR> system virtualip enable eth0 10.1.4.223 REPLICATOR> system virtualip disable eth0 10.1.4.223

upload supportfiles¶

Function	Sends collected support files to Plixer support for analysis after using the `collect supportfiles` command
Syntax	upload supportfiles REPLICATOR> upload supportfiles

version¶

Function	Shows the current version of the Plixer Replicator
Syntax	version REPLICATOR> version