# Built in Plugins APIs

You can use the built-in plugin APIs and built-in collector or fetcher APIs to configure and manage the built-in applications of Fabric-enabled LogPoints.

## Built-in Collectors and Fetchers

You can find the following built-in collector and fetcher APIs in the API Server:

| **Collector APIs**   | **Fetcher APIs** |
| -------------------- | ---------------- |
| FileSystemCollector  | FTPFetcher       |
| FTPCollectorPlugin   | SCPFetcher       |
| SyslogCollector      | SNMPFetcher      |
| SnareCollectorPlugin | WMIFetcherPlugin |
| SNMPTrapCollector    |                  |
| SFlowCollectorPlugin |                  |

{% hint style="info" %}
You can list the collectors or fetchers configured in a Fabric-enabled LogPoint by using the **Devices - List API**.
{% endhint %}

### Collector APIs

The **Collector** APIs allow you to create, edit, and delete collectors on behalf of Fabric-enabled LogPoints.

Collectors listen to dedicated ports and transfer the logs for further processing.

#### FileSystemCollector

The **FileSystemCollector** API allows you to create, edit, and delete *file system collectors* on behalf of a Fabric-enabled LogPoint.

A *file system collector* captures all the internal logs from collectors, web servers, mergers, normalizers, and all the other applications of a Fabric-enabled LogPoint.

<table data-header-hidden><thead><tr><th width="249"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Creates a new file system collector.</td></tr><tr><td>Edit</td><td>Edits the file system collector with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the file system collector with the given ID.</td></tr></tbody></table>

#### FTPCollectorPlugin

The **FTPCollectorPlugin** API allows you to create, edit, and delete *FTP collectors* on behalf of a Fabric-enabled LogPoint.

An *FTP collector* collects logs from the files uploaded by users to the Fabric-enabled LogPoint using FTP clients.

<table data-header-hidden><thead><tr><th width="249.00006103515625"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new FTP collector.</td></tr><tr><td>Edit</td><td>Edits the FTP collector with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the FTP collector with the given ID.</td></tr></tbody></table>

#### SFlowCollectorPlugin

The **SFlowCollectorPlugin** API allows you to create, edit, and delete *SFlow collectors* on behalf of a Fabric-enabled LogPoint.

*SFlow* is a sampling technology used to monitor networks, wireless and host devices. The sampled packets are called flow packets. You can forward the flow packets into a Fabric-enabled LogPoint via the SFlow Collector.

<table data-header-hidden><thead><tr><th width="249.8333740234375"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new SFlow collector plugin using device ID or policy ID.</td></tr><tr><td>Edit</td><td>Edits the SFlow collector plugin with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the SFlow collector plugin with the given ID.</td></tr></tbody></table>

#### SnareCollectorPlugin

The **SnareCollectorPlugin** API allows you to create, edit, and delete *Snare collectors* on behalf of a Fabric-enabled LogPoint.

A *Snare collector* collects and analyzes logs from the **Windows Snare** agent.

<table data-header-hidden><thead><tr><th width="249.83331298828125"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new Snare collector plugin.</td></tr><tr><td>Edit</td><td>Edits the Snare collector plugin with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the Snare collector plugin with the given ID.</td></tr></tbody></table>

#### SNMPTrapCollector

The **SNMPTrapCollector** API allows you to create, edit, and delete *SNMP trap collectors* on behalf of a Fabric-enabled LogPoint.

An *SNMP trap collector* collects logs from SNMP enabled devices. SNMP traps are alert messages that devices use to notify the SNMP manager about the occurrence of significant events.

<table data-header-hidden><thead><tr><th width="250.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new SNMP trap collector.</td></tr><tr><td>Edit</td><td>Edits the SNMP trap collector with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the SNMP trap collector with the given ID.</td></tr></tbody></table>

#### SyslogCollector

The **SyslogCollector** API allows you to create, edit, and delete *Syslog collectors* on behalf of a Fabric-enabled LogPoint.

A *Syslog collector* is used to collect data from the sources following the Syslog protocol. Once you add a device, it can be utilized either as a proxy or as a device depending on its configuration mode.

<table data-header-hidden><thead><tr><th width="250.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new Syslog collector.</td></tr><tr><td>Edit</td><td>Edits the Syslog collector with the given ID.</td></tr><tr><td>Trash</td><td>Deletes the Syslog collector with the given ID.</td></tr></tbody></table>

### Fetcher APIs

The **Fetcher** APIs allow you to create, edit, and delete fetchers on behalf of Fabric-enabled LogPoints.

Fetchers fetch logs from a remote location. You need to provide relevant parameters to configure the fetchers.

#### FTPFetcher

The **FTPFetcher** API allows you to configure and manage *FTP fetchers* on behalf of a Fabric-enabled LogPoint.

The configuration of the *FTP fetcher* sets up an FTP client in the Fabric-enabled LogPoint. Once the FTP client is configured, you can pull the log files hosted on remote FTP servers.

<table data-header-hidden><thead><tr><th width="249.8333740234375"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new FTP fetcher.</td></tr><tr><td>Edit</td><td>Edits the FTP fetcher with the given ID.</td></tr><tr><td>TestExisting</td><td>Tests the FTP fetcher with the given ID.</td></tr><tr><td>TestNew</td><td>Tests the newly created FTP fetcher.</td></tr><tr><td>Trash</td><td>Deletes the FTP fetcher with the given ID.</td></tr></tbody></table>

#### SCPFetcher

The **SCPFetcher** API allows you to configure and manage *SCP fetchers* on behalf of a Fabric-enabled LogPoint.

An *SCP fetcher* fetches logs from the log files present in a remote host using the SSH connection.

<table data-header-hidden><thead><tr><th width="250.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new SCP fetcher.</td></tr><tr><td>Edit</td><td>Edits the SCP fetcher with the given ID.</td></tr><tr><td>TestExisting</td><td>Tests the SCP fetcher with the given ID.</td></tr><tr><td>TestNew</td><td>Tests the newly created SCP fetcher.</td></tr><tr><td>Trash</td><td>Deletes the SCP fetcher with the given ID.</td></tr></tbody></table>

#### SNMPFetcher

The **SNMPFetcher** API allows you to configure and manage *SNMP fetchers* on behalf of a Fabric-enabled LogPoint.

An **SNMP fetcher** allows you to make SNMP queries to network devices to get the responses into the LogPoint. You can then use these responses as event logs for further analysis.

<table data-header-hidden><thead><tr><th width="251.5"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new SNMP fetcher.</td></tr><tr><td>Edit</td><td>Edits the SNMP fetcher with the given ID.</td></tr><tr><td>TestExisting</td><td>Tests the SNMP fetcher with the given ID.</td></tr><tr><td>TestNew</td><td>Tests the newly created SNMP fetcher.</td></tr><tr><td>Trash</td><td>Deletes the SNMP fetcher with the given ID.</td></tr></tbody></table>

#### WMIFetcherPlugin

The **WMIFetcherPlugin** API allows you to configure and manage *WMI fetcher plugin* on behalf of a Fabric-enabled LogPoint.

**Windows Management Instrumentation (WMI)** is a platform developed by Microsoft for sharing information and notifications. You can use the **WMI fetcher** to collect the information from the Windows devices using the WMI service.

<table data-header-hidden><thead><tr><th width="247.33331298828125"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Create</td><td>Adds a new WMI fetcher using device ID or policy ID.</td></tr><tr><td>Edit</td><td>Edits the WMI fetcher with the given ID.</td></tr><tr><td>TestExisting</td><td>Tests the WMI fetcher with the given ID.</td></tr><tr><td>TestNew</td><td>Tests the newly created WMI fetcher.</td></tr><tr><td>Trash</td><td>Deletes the WMI fetcher with the given ID.</td></tr></tbody></table>

## Other Built-in Plugins

These APIs allow you to configure and manage plugins on behalf of Fabric-enabled LogPoints.

### IPLookup

The **IPLookup** API allows you to install and manage the *IP Lookup* Plugin on behalf of a Fabric-enabled LogPoint. The API also allows you to upload CSV files used by the plugin.

The **IP Lookup Process Plugin** enriches the log messages with the Classless Inter-Domain Routing (CIDR) address details uploaded in CSV format during the configuration of the plugin.

For a chosen IP type within log results, this plugin matches the IP with the content of the user-defined Lookup table and hence enriches them by adding the CIDR details.

<table data-header-hidden><thead><tr><th width="250.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Delete</td><td>Deletes an IP lookup table with the given ID.</td></tr><tr><td>Install</td><td>Installs the applications and patches already uploaded to the Fabric Storage, to the Fabric-enabled LogPoint.</td></tr><tr><td>List</td><td>Lists the IP Lookup tables.</td></tr><tr><td>TrashPrivate</td><td>Deletes the file with the given name from the private storage.</td></tr><tr><td>TrashPublic</td><td>Deletes the file with the given name from the public storage.</td></tr><tr><td>UploadPublic</td><td>Uploads the files to the private storage.</td></tr><tr><td>UploadPublic</td><td>Uploads the files to the public storage.</td></tr><tr><td>UploadsList</td><td>Lists the files uploaded in the private storage.</td></tr><tr><td>UploadsListPublic</td><td>Lists the files uploaded in the public storage.</td></tr></tbody></table>

### LDAPAuthentication

The **LDAPAuthentication** API allows you to configure and manage the LDAP Authentication strategies on behalf of a Fabric-enabled LogPoint.

The LDAP (Lightweight Directory Access Protocol) is an application protocol developed to access and maintain distributed directory information services over an Internet Protocol (IP) network. You can use the LDAP service to authenticate for a Fabric-enabled LogPoint.

You need to configure the LDAP strategy in LogPoint to use the LDAP service.

<table data-header-hidden><thead><tr><th width="250.66668701171875"></th><th></th></tr></thead><tbody><tr><td><strong>Endpoint</strong></td><td><strong>Description</strong></td></tr><tr><td>Activate</td><td>Activates the LDAP authentication strategy in the LogPoint.</td></tr><tr><td>Create</td><td>Adds a new LDAP authentication strategy.</td></tr><tr><td>Deactivate</td><td>Deactivates the LDAP authentication strategy in the LogPoint.</td></tr><tr><td>Edit</td><td>Updates the existing LDAP strategy with the given ID.</td></tr><tr><td>Get</td><td>Fetches the LDAP strategy with the given ID.</td></tr><tr><td>GetLDAPGroup</td><td>Fetches the LDAP users group with the given ID.</td></tr><tr><td>List</td><td>Lists the LDAP strategies.</td></tr><tr><td>ListLDAPGroup</td><td>Lists the LDAP users groups.</td></tr><tr><td>MapLDAPGroup</td><td>Maps the LDAP user group to LogPoint user group.</td></tr><tr><td>RefreshLDAPGroupList</td><td>Updates the list of LDAP user groups.</td></tr><tr><td>Trash</td><td>Deletes the LDAP strategy with the given ID.</td></tr></tbody></table>
