Elastic network drive connector reference
editElastic network drive connector reference
editThe Elastic network drive connector is a connector for network drive data sources.
Availability and prerequisites
editThis connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.
This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Usage
editTo use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.
Configuration
editWhen using the build a connector workflow, intially these fields will use the default configuration set in the connector source code.
These are set in the get_default_configuration function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
-
username - The username of the account for the network drive. The user must have at least read permissions for the folder path provided.
-
password - The password of the account to be used for crawling the network drive.
-
server_ip -
The server IP address where the network drive is hosted.
Default value is
127.0.0.1. -
server_port -
The server port where the network drive service is available.
Default value is
445. -
drive_path -
-
The network drive path the connector will crawl to fetch files.
This is the name of the folder shared via SMB.
The connector uses the Python
smbprotocollibrary which supports both SMB v2 and v3. - Accepts only one path— parent folders can be specified to widen the scope.
-
The drive path should use forward slashes as path separators. Example:
-
admin/bin
-
-
The network drive path the connector will crawl to fetch files.
This is the name of the folder shared via SMB.
The connector uses the Python
-
enable_content_extraction -
Whether the connector should extract file content from the network drive. Default value is
Truei.e. the connector will try to extract file contents.If
enable_content_extraction=Falsethe connector will not attempt to download the content of files in the network drive. Don’t confuse this with the "Deployment wide content extraction" setting in the Kibana UI. This deployment-wide setting toggles binary content extraction and is powered by ingest pipelines.
Documents and syncs
editThe connector syncs folders as separate documents in Elasticsearch.
The following fields will be added for the document type folder:
-
create_time -
title -
path -
modified -
time -
id
Sync rules
edit- Files bigger than 10 MB won’t be extracted.
- Permission are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
- Filtering rules are not available in the present version. Currently filtering is controlled via ingest pipelines.
End-to-end tests
editThe connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To execute a functional test for the Network Drive connector client, run the following command:
$ make ftest NAME=network_drive
By default, this will use a medium-sized dataset.
For faster tests add the DATA_SIZE=small flag:
make ftest NAME=network_drive DATA_SIZE=small
Known issues
editThere are no known issues for this connector.
See Known issues for any issues affecting all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Framework and source
editThis connector is included in the Python connectors framework.
View the source code for this connector (branch 8.7, compatible with Elastic 8.7).