Advanced Services¶

This section covers the use of Plixer Replicator’s advanced services, which allow the appliance to support a wider range of complex scenarios.

Interactive Mode¶

Interactive Mode is Plixer Replicator’s command line interface (CLI) and is an alternative to the web interface as a means of controlling and managing the appliance’s features and functionality.

Launching Interactive Mode¶

To start issuing commands to the Plixer Replicator in Interactive Mode, first establish a connection with the hardware or virtual appliance using an SSH client and the credentials configured during initial deployment.

Important

The default command line username and password are root and replicator, respectively.

[root@demo ~]# ssh [email protected]
[email protected]'s password:
Plixer Replicator (TM) v18.14.1.2410
2019-12-03 13:07:44 -0500 (Tue, 03 Dec 2019)
Copyright (C) 2012 - 2019 Plixer, All rights reserved.
Replicate Anything!
Need an IPFIX Collector? Download Scrutinizer at https://www.plixer.com
Machine ID : 6YZ6XEPT66FPH6364A1VQ8NY
Customer ID : qa replicator
Licensed Version : 18.5
Licensed Type : subscription (standalone/primary)
Expiration : 11/30/2020
REPLICATOR>

The REPLICATOR> prompt confirms that the Plixer Replicator is ready to accept commands.

List of Interactive Mode Commands¶

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¶

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¶

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¶

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

Fault tolerant deployments¶

A second Plixer Replicator can be set up to create a fault tolerant system in scenarios where primary appliance needs to be taken offline or becomes unavailable for any reason. This functionality is available for both hardware and virtual appliances (or a combination of the two).

There are two methods for configuring the secondary or backup Plixer Replicator for fault tolerance.

Traditional configuration¶

The traditional configuration for fault tolerance is meant for systems with two Plixer Replicators on different subnets. In this configuration, the secondary appliance actively monitors the state of the primary appliance and regularly syncs its database with the primary’s settings.

When the secondary Plixer Replicator detects that the primary appliance is offline, it attempts to reach all known Collectors. If the Collectors are reachable, the secondary Plixer Replicator takes over replication operations based on the Profiles configured when its database was last synced with the primary appliance. If Collectors are not reachable, it maintains its secondary state until a Collector or the primary Plixer Replicator becomes reachable again.

The seondary Plixer Replicator will continue to monitor the state of the primary appliance, even after it has taken over replication functions. When the primary Plixer Replicator is reachable again, the secondary will sync any updates to the primary’s database before reverting to its previous monitor-and-sync state.

Important

When a Plxer Replicator is set as a secondary appliance, its current configuration will be replaced by the database synced from the primary appliance and it will no longer allow changes to its settings. The role and show commands may still be issued in Interactive Mode, but any modification of its Profile and global settings must be done through the primary Plixer Replicator.

Requirements¶

The following are required to set up a fault tolerant configuration using the traditional method:

A primary Plixer Replicator
A secondary Plixer Replicator
Exporters that are configured to send data to the IP addresses of the primary and secondary appliances
A fault tolerance license key for the secondary Plixer Replicator

Note

To obtain a fault tolerance license key, contact Plixer directly.

Configuring the secondary Plixer Replicator (Traditional)¶

To set up the Plixer Replicator as the secondary appliance in the traditional configuration:

Deploy the appliance as normal following the instructions in the deployment guides.
Use the role command to set it as the secondary Plixer Replicator:
```
REPLICATOR> role set secondary [primary_ip:listner_port] [timeout]
```
The listener_port must be a port being used by the primary Plixer Replicator to actively listen for packets, and the timeout argument sets the number of polls the primary appliance must miss before the secondary attempts to take over replication functions. The default timeout value is 2 polls.
Test the the secondary Plixer Replicator’s connectivity to the primary appliance by running the following command:
```
REPLICATOR> role test secondary
```

If the test runs successfully, the secondary Plixer Replicator has been correctly configured for fault tolerance.

Disabling Traditional fault tolerance¶

A secondary Plixer Replicator in the traditional configuration can be set as a standalone appliance at any time by issuing the command:

REPLICATOR> role set primary

High Availability configuration¶

The High Availability configuration for fault tolerance is meant for systems with Plixer Replicators on the same subnet. In this configuration, packets are sent to a virtual IP address that the primary (master) and secondary (backup) appliances are both configured to listen to for traffic. Because each Plixer Replicator in High Availability mode is assigned a priority, they are aware of their primary/secondary role in the configuration.

When the primary Plixer Replicator fails, the packet streams are immediately picked up by the secondary appliance and forwarded to the same Collectors. Once the primary is active again, it will resume its previous replication functions.

The High Availabiity configuration can be used to set up redundancy beyond basic primary and secondary roles.

Requirements¶

The following are required to set up a fault tolerant configuration using the traditional method:

A primary Plixer Replicator
A secondary Plixer Replicator
Exporters that are configured to send data to a single virtual IP address
A fault tolerance license key for the secondary Plixer Replicator

Configuring the secondary Plixer Replicator (High Availability)¶

To set up the Plixer Replicator as the secondary appliance in the High Availability configuration:

Deploy the appliance as normal following the instructions in the deployment guides.
Add the virtual IP address to the primary Plixer Replicator using the following command:
```
REPLICATOR> system virtualip enable eth0 [virtual_ip]
```

Set the IP address of the primary appliance:

REPLICATOR> role set ha master [primary_ip]

Enable High Availability on the primary Plixer Replicator:
```
REPLICATOR> role set ha on 101 [virtual_ip] eth0 master
```
Add the virtual IP address to the secondary Plixer Replicator by running the following command:
```
REPLICATOR> system virtualip enable eth0 [virtual_ip]
```
Set the IP address of the primary Plixer Replicator on the secondary appliance:
```
REPLICATOR> role set ha master [primary_ip]
```
Enable High Availability on the secondary Plixer Replicator:
```
REPLICATOR> role set ha on 100 [virtual_ip] eth0 backup
```
Test whether High Availability has been successfully configured:
1. Run the following command on the primary and secondary Plixer Replicators:
```
REPLICATOR> role test ha
```
2. Shut down the primary appliance and ping the virtual IP address.

If a response is received from the virtual IP address, High Availability has been correctly configured and the primary Plixer Replicator can be restarted as normal.

Note

When prompted, enter the root user’s password for the primary Plixer Replicator.

Disabling the High Availability configuration¶

To revert Plixer Replicators from High Availability to their previous state, run the following commands on the primary and secondary Plixer Replicators:

REPLICATOR> role set ha off
REPLICATOR> system virtualip disable eth0 [virtual_ip]

Plixer Replicator APIs¶

Authentication¶

Used to authenticate the user and start/stop API sessions

Login

Starts a new API session

GET request:

Note

Legacy API – Deprecated- recommend using POST

Resource URL:

https://[replicator]/api/1/login/[sha2]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[sha2]	Interactive Mode (CLI) password converted to SHA2 512-bit hex

Example request:

https://10.30.17.131/api/1/login/098f6bcd4621d373ca098f6bcd4621d563cade4e832629b4f6d098f4bcd4621d373cade4e831627b4f6e4e832627b4f

POST request:

Starts a new API session

Resource URL:

POST https://[replicator]/api/1/login/

{
 “user” : “admin”
 “passwd”: “[passwd]”
}

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[passwd]	SHA512 hash of the password for the admin username

Example response:

{
  "path": "login successful.",
"result": "success"
}

Log out

Manually terminates an API session (API sessions are automatically terminated after 30 minutes)

Resource URL:

https://[replicator]/api/1/logout

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/logout

Example response:

{
  "path": "logout successful.",
  "result": "success"
}

Acknowledge¶

Used to acknowledge Collectors and Exporters that have triggered Alarms

Resource URL:

https://[replicator]/api/1/acknowledge/[entity]/[ip:port]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[entity]	`exporter` or `collector`
[ip:port]	IP address and port of the [entity] to be acknowledged

Example request:

https://10.30.17.131/api/1/acknowledge/collector/10.1.10.4:2055

Example response:

{
   "description": "Success: collector '10.1.10.4:2055' acknowledged.",
   "result": "success"
}

Collector¶

Used for Collector management operations within Profiles

Resource URL:

Manages a Collector for an individual Profile

https://[replicator]/api/1/collector/[action]/[ip]/[profile]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`add` or `remove`
[ip]	IP address of the Collector
[profile]	Target Profile for the operation

Example request:

https://10.30.17.131/api/1/collector/add/10.1.10.60/myprofile

Example response:

{
  "description": "Success: Collector [10.1.10.60] -> Profile [myprofile]",
  "result": "success"
}

Resource URL:

Removes a Collector from all Profiles

https://[replicator]/api/1/collector/allremove/[ip]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[ip]	IP address of the Collector to be removed

Example request:

https://10.30.17.131/api/1/collector/allremove/10.1.10.4

Example response:

{
  "description": "Success: Collector [10.1.10.4] <- All Profiles",
  "result": "success"
}

DNSCheck¶

Used to perform a DNS check on an IP address

Resource URL:

Forces a DNS name resolution for an IP address

https://[replicator]/api/1/dnscheck/[ip]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[ip]	IP address to resolve

Example request:

https://10.30.17.131/api/1/dnscheck/10.1.1.3

Example response:

{
  "dnscheck": {
  "addr": "10.1.1.3",
  "expiry": {
  "epoch": 1462801036,
  "time": "Mon May 9 09:37:16 2016"
  },
  "name": "newexp.plxr.local",
  "resolveTime": 0.04485,
  "status": "success"
  }
}

Exporter¶

Used for Exporter management operations within Profiles

Resource URL:

Manages an Exporter for an individual Profile

https://[replicator]/api/1/exporter/[action]/[ip]/[profile]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`add` or `remove`
[ip]	IP address of the Exporter
[profile]	Target Profile for the operation

Example request:

https://10.30.17.131/api/1/exporter/add/10.1.1.1/myprofile

Example response:

{
  "description": "Success: Exporter [10.1.1.1] -> Profile [myprofile]",
  "result": "success"
}

Resource URL:

Removes an Exporter from all Profiles

https://[replicator]/api/1/exporter/allremove/[ip]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[ip]	IP address of the Exporter to be removed

Example request:

https://10.30.17.131/api/1/exporter/allremove/10.1.1.4

Example response:

{
   "description": "Success: Exporter [10.1.1.4] <- All Profiles",
   "result": "success"
}

Resource URL:

Identifies Exporters that are sending data to the Plixer Replicator but not assigned to any Profiles

https://[replicator]/api/1/exporter/noprofile/[filter]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[filter]	Optional filter to apply to the displayed list of Exporters not assigned to any Profiles; returns the full list if not provided

Example request:

https://10.30.17.131/api/1/exporter/noprofile/0

Example response:

{
  "noprofile": {
    "10.30.17.131": {
      "in_o_delta": 0,
      "in_o_rate": "0.0",
      "in_p_delta": 0,
      "in_p_rate": "0.0",
      "lastseen": "Tue Apr 19 09:55:18 2016",
      "out_o_delta": 1493,
      "out_o_rate": "49.8",
      "out_p_delta": 6,
      "out_p_rate": "0.2",
      "unixtime": 1461074118
    },
    "total": 1
  }
}

License¶

Used to check the status of the current Plixer Replicator license

Resource URL:

Returns the details of the current license

https://[replicator]/api/1/license/check

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/license/check

Example response:

{
    "daysLeft" : "365 day(s)",
    "expiration" : "Thu May 18 2017",
    "licensedType" : "eval",
    "licensedVersion" : "16.6",
    "machineID" : "6YZ6XEPTA66JA6VHFPXG749B",
    "role" : "failover"
}

Notate¶

Used to add a description to an Exporter, Collector, or Profile

Resource URL:

https://[replicator]/api/1/notate/[entity]/[identity]/[description]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[entity]	`profile` or `ip`
[identity]	`[profile_name]` or `[ip_address]` of entity specified
[description]	Description or note to add to the entity in standard ASCII URI-compatible characters

Example request:

https://10.30.17.131/api/1/notate/profile/myprofile/My_Fantastic_Description

Example response:

{
    "description": "Success: Profile 'myprofile' has a new description",
    "result": "success"
}

Policies¶

Used to manage Policies for Profiles

Resource URL:

https://[replicator]/api/1/policies/[action]/[network]/[cidr]/[profile]/[incexc]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`add` or `remove`
[network]	address of the network (e.g. 172.17.0.0)
[cidr]	CIDR of the network specified (e.g. 16)
[profile]	Target Profile for the operation
[incexc]	`include` or `exclude`

Example request:

https://10.30.17.131/api/1/policies/add/10.1.20.0/16/myprofile/include

Example response:

{
    "description": "Success: Policy [10.1.20.0/16] -> Profile [myprofile]",
    "result": "success"
}

Profile¶

Used to manage Profile settings and behavior

Resource URL:

Renames an existing Profie

https://[replicator]/api/1/profile/rename/[current]/[new]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[current]	Name of the Profile to be renamed
[new]	New name for the Profile

Example request:

https://10.30.17.131/api/1/profile/rename/oldprofile/myprofile

Example response:

{
    "description": "Success: Profile 'oldprofile' is now 'myprofile'",
    "result": "success"
}

Resource URL:

Toggles the Singularity flag for a Profile

https://[replicator]/api/1/profile/singularity/[name]/[action]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[name]	Name of the Profile to be updated
[action]	`enable` or `disable`

Example request:

https://10.30.17.131/api/1/profile/singularity/myprofile/enable

Example response:

{
    "description": "Success: Profile 'myprofile' singularity enabled",
    "result": "success"
}

Resource URL:

Removes, disables, or enables a Profile

https://[replicator]/api/1/profile/[action]/[name]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`remove`, `disable`, or `enable`
[name]	Target Profile for the operation

Example request:

https://10.30.17.131/api/1/profile/disable/myprofile

Example response:

{
    "description": "Success: Profile myprofile has been set to 'disable'",
    "result": "success"
}

Resource URL:

Creates a new Profile or updates an existing one

https://[replicator]/api/1/profile/[action]/[name]/[listeningport]/[sendingport]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`add` or `update`
[name]	Name of the Profile to create or update
[listeningport]	UDP port to listen to for incoming packets (In Port)
[sendingport]	The UDP port to send packets from (Out Port)

Example request:

https://10.30.17.131/api/1/profile/add/myprofile/2055/4739

Example response:

{
    "description": "Success: Profile 'myprofile' has been added and enabled.",
    "result": "success"
}

Rebuild¶

Used to force the Plixer Replicator to immediately rebuild its internal configuration

Resource URL:

https://[replicator]/api/1/rebuild

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/rebuild

Example response:

{
    "description": "rebuild request submitted",
    "result": "success"
}

Role¶

Used to test whether a secondary Plixer Replicator in a fault tolerant configuration has been configured correctly

Resource URL:

https://[replicator]/api/1/role/test/secondary

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/role/test/secondary

Example response:

{
    "description": "!!! This replicator is the primary !!!",
    "result": "error"
}

Setting¶

Used to manage the Plixer Replicator’s global settings

Resource URL:

Sets the value for the specified setting

https://[replicator]/api/1/setting/set/[name]/[value]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[name]	Exact name of the setting to modify
[value]	New value for the setting specified

Example request:

https://10.30.17.131/api/1/setting/set/metricssent/10.1.2.3:2055

Example response:

{
    "description": "Success: setting 'metricssent' has been set to '10.1.2.3:2055'",
    "result": "success"
}

Resource URL:

Enables or disables the specified setting

https://[replicator]/api/1/setting/[action]/[name]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`enable` or `disable`
[name]	Exact name of the setting to modify

Example request:

https://10.30.17.131/api/1/setting/disable/metricssent

Example response:

{
    "description": "Success: setting 'metricssent' has been set to 'disable'",
    "result": "success"
}

Show¶

Displays configuration details and real-time information from the Plixer Replicator

Resource URL:

Displays the current configuration of the Plixer Replicator

https://[replicator]/api/1/show/config

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/show/config

Example response:

{
 "api": {
  "collector": [
   "/api/1/collector/add/10.30.1.20/benchmark-20",
   ...
  ],
  "notate": [
   "/api/1/notate/ip/10.1.4.101/ej-win2012 install test machine (fresh)",
   ...
  ],
  "policy": [
   "/api/1/policies/add/10.1.1.252/32/buildqa/include",
   ...
  ],
  "profile": [
   "/api/1/profile/add/frandev/2002/2055",
   ...
  ]
 },
 "cli": {
  "collector": [
   "collector add 10.30.1.20 benchmark-20",
   ...
  ],
  "notate": [
   "notate ip 10.1.4.101 ej-win2012 install test machine (fresh)",
   ...
  ],
  "policy": [
   "policy add 10.1.1.252/32 buildqa include",
   ...
  ],
  "profile": [
   "profile add frandev 2002 2055",
   ...
  ]
 }
}

Resource URL:

Displays the current status of the Plixer Replicator

https://[replicator]/api/1/show/status

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/show/status

Example response:

{
   "converting syslog" : "active",
   "ipfixify system metrics" : "active",
   "replicating port 2002" : "active",
   "replicating port 2003" : "active",
   "replicating port 2055" : "active",
   "replicator api" : "active",
   "replicator license" : "259 day(s)",
   "replicator monitor" : "active",
   "replicator vitalizer" : "active",
   "result" : "success",
   "version" : "v17.12.19.2255"
}

Resource URL:

Displays real-time data from the Plixer Replicator

https://[replicator]/api/1/show/realtime/[filter]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[filter]	Currently not supported; defaults to full report if not provided

Example request:

https://10.30.17.131/api/1/show/realtime/0

Example response:

{
 "collector": {
  "10.1.4.19": {
   "in": {
    "octets": {
     "delta": 0,
     "rate": 0
    },
     "packets": {
     "delta": 0,
     "rate": 0
    }
   }
  },
  "10.1.4.20": {
   ...
  },
},
"exporter": {
 "10.30.17.131": {
  "awareness": {
   "last_epoch": 1461175921,
   "last_timestamp": "2016-04-20 14:12:01"
  },
  "in": {
   "octets": {
    "delta": 0,
    "rate": "0.0"
   },
   "packets": {
    "delta": 0,
    "rate": "0.0"
   }
  },
  "out": {
   "octets": {
    "delta": 0,
    "rate": "0.0"
   },
   "packets": {
    "delta": 0,
    "rate": "0.0"
   }
  },
  "profiles": [
   "benp"
  ]
 }
},
"pair": {
 "10.30.17.131 -> 10.1.4.19": {
  "octets": {
   "delta": 0,
   "rate": 0
  },
  "packets": {
   "delta": 0,
   "rate": 0
  }
 },
 "10.30.17.131 -> 10.1.4.20": {
  ...
 },
 "profile": {
  "benp": {
   "in": {
    "octets": {
     "delta": 0,
     "rate": 0
    },
    "packets": {
     "delta": 0,
     "rate": 0
    }
   },
   "out": {
    "octets": {
     "delta": 0,
     "rate": 0
    },
   "packets": {
    "delta": 0,
    "rate": 0
   }
  }
 }
},
"stats": {
 "totals": {
  "collectors": 2,
  "exporters": 1,
  "pairs": 2,
  "profiles": {
   "disabled": 3,
   "enabled": 67,
   "total": 70
  }
 }
},
"system": {
 "cpu": "0"
}

Resource URL:

Displays various configured information for the Plixer Replicator

https://[replicator]/api/1/show/[entity]/[filter]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[entity]	`alarms`, `assets`, `collectors`, `config`, `exporters`, `profile`, `realtime`, `settings`, or `status`
[filter]	Optional filter to apply to the output; defaults to the full report if not provided

Example request:

https://10.30.17.131/api/1/show/collector/10.1.10.1

Example response:

{
 "collector": {
  "10.1.10.1": {
   "acknowledged": [
    9996
   ],
   "description": "erpdev",
   "in_profiles": [
    "steady-replays"
   ],
   "ip": "10.1.10.1",
   "name": null,
   "status": {
    "unreachable_port": [
     "9996"
    ],
   }
   "threshold": 10000
  }
 }
}

Threshold¶

Used to set packet per second thresholds that will trigger warnings for Collectors

Resource URL:

https://[replicator]/api/1/collector/threshold/[collector]/[threshold]

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[collector]	IP address of the Collector
[threshold]	Threshold value in packets per second; disabled if set to 0

Example request:

https://10.30.17.131/api/1/collector/threshold/10.1.5.2/10000

Example response:

{
  "description": "Success: Collector [10.1.5.2] threshold set to 10000",
  "result": "success"
}

Version¶

Used to display the Plixer Replicator’s version information

Resource URL:

https://[replicator]/api/1/version

Parameter

Description

[replicator]

Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/version

Example response:

{
      "apiversion" : "1",
      "bestipfixcollector" : "Need an IPFIX Collector? Download Scrutinizer at https://www.plixer.com",
      "build" : "2019-12-03 13:07:44 -0500 (Tue, 03 Dec 2019)",
      "copyright" : "Copyright (C) 2012 - 2019 Plixer, All rights reserved.",
      "name" : "Plixer Replicator (TM) v18.14.1.2410 ",
      "result" : "success",
      "yeswecan" : "Replicate Anything!"
}