Windows Share SMB 2/3 V2 Connector Configuration Reference

Table of Contents

Configuration

The Windows Share connector can access content in a Windows Share or Server Message Block (SMB 2 and 3 protocols)/Common Internet File System (CIFS) filesystem.

Configuration

When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.

Connector for Windows (SMB) shares

description - string

Optional description

<= 125 characters

pipeline - stringrequired

Name of the IndexPipeline used for processing output.

>= 1 characters

Match pattern: ^[a-zA-Z0-9_-]+$

diagnosticLogging - boolean

Enable diagnostic logging; disabled by default

Default: false

parserId - string

The Parser to use in the associated IndexPipeline.

Match pattern: ^[a-zA-Z0-9_-]+$

coreProperties - Core Properties

Common behavior and performance settings.

fetchSettings - Fetch Settings

System level settings for controlling fetch behavior and performance.

pluginInstances - number

Maximum number of plugin instances for distributed fetching. Only specified number of plugin instanceswill do fetching. This is useful for distributing load between different instances.

<= 500

exclusiveMinimum: false

exclusiveMaximum: false

Default: 0

Multiple of: 1

fetchResponseScheduledTimeout - number

The maximum amount of time for a response to be scheduled. The task will be canceled if this setting is exceeded.

>= 1000

<= 500000

exclusiveMinimum: false

exclusiveMaximum: false

Default: 300000

Multiple of: 1

indexingInactivityTimeout - number

The maximum amount of time to wait for indexing results (in seconds). If exceeded, the job will fail with an indexing inactivity timeout.

>= 60

<= 691200

exclusiveMinimum: false

exclusiveMaximum: false

Default: 86400

Multiple of: 1

pluginInactivityTimeout - number

The maximum amount of time to wait for plugin activity (in seconds). If exceeded, the job will fail with a plugin inactivity timeout.

>= 60

<= 691200

exclusiveMinimum: false

exclusiveMaximum: false

Default: 600

Multiple of: 1

indexMetadata - boolean

When enabled the metadata of skipped items will be indexed to the content collection

Default: false

indexContentFields - boolean

When enabled, content fields will be indexed to the crawl-db collection

Default: false

numFetchThreads - number

Maximum number of fetch threads; defaults to 20.This setting controls the number of threads that call the Connectors fetch method.Higher values can, but not always, help with overall fetch performance.

>= 1

<= 500

exclusiveMinimum: false

exclusiveMaximum: false

Default: 20

Multiple of: 1

indexingThreads - number

Maximum number of indexing threads; defaults to 4.This setting controls the number of threads in the indexing service used for processing content documents emitted by this datasource.Higher values can sometimes help with overall fetch performance.

>= 1

<= 10

exclusiveMinimum: false

exclusiveMaximum: false

Default: 4

Multiple of: 1

id - stringrequired

A unique identifier for this Configuration.

>= 1 characters

Match pattern: ^[a-zA-Z0-9_-]+$

properties - Windows Share properties

Plugin specific properties.

authentication - Authentication Properties

domain - string

Windows File Share Domain

username - string

Windows File Share Username

password - string

Windows File Share Password

server - Server Properties

serverName - string

The Windows share server name. (FQDN or IP)

shares - array[object]

List of Windows 'Shares' to be crawled

object attributes:{shareName required : {
display name: Share Name
type: string
}paths : {
display name: Folder/File path inside a share
type: array
}}

connection - Connection Properties

connectTimeout - number

Timeout sets Read, Write, and Transact timeouts (default is 120 seconds)

>= -2147483648

<= 2147483647

exclusiveMinimum: false

exclusiveMaximum: false

Default: 120

Multiple of: 1

socketTimeout - number

Socket Timeout (default is 0 seconds, blocks forever)

>= -2147483648

<= 2147483647

exclusiveMinimum: false

exclusiveMaximum: false

Default: 180

Multiple of: 1

enableDfs - boolean

Whether or not to enable distributed windows file shares.

Default: true

multiProtocolNegotiate - boolean

Enable multi protocol negotiate

Default: true

security - Security Trimming Properties

enabled - boolean

Enable query-time security-trimming

Default: true

collectionId - string

Id of the collection to be used for storing ACL records. If not specified, ACL collection name will be generated automatically using pattern '<datasource_id>_access_control_hierarchy'.

limitDocument - Limit documents Properties

Documents filtering options

includedFileExtensions - array[string]

Set of file extensions to be fetched. If specified, all non-matching files will be skipped.

Default:

excludedFileExtensions - array[string]

A set of all file extensions to be skipped from the fetch.

Default:

inclusiveRegexes - array[string]

Regular expressions for path patterns to include. This will limit this datasource to only paths that match the regular expression.

Default:

exclusiveRegexes - array[string]

Regular expressions for path patterns to exclude. This will limit this datasource to only paths that do not match the regular expression.

Default:

maxSizeBytes - number

Used for excluding files size larger than the configured value.

>= -2147483648

<= 2147483647

exclusiveMinimum: false

exclusiveMaximum: false

Default: -1

Multiple of: 1

minSizeBytes - number

Used for excluding files size smaller than the configured value.

>= -2147483648

<= 2147483647

exclusiveMinimum: false

exclusiveMaximum: false

Default: 1

Multiple of: 1

indexFolderMetadata - boolean

Enable indexing of folder metadata.

Default: false