The SMB Connector can be configured using the Rest API. It requires the following entities to be created:

Connection
Connector
Seed
Credential
Seed

Bellow are the examples of how to create the Connection and , the Seed, the Credential. For the Connector please check this page.

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Create Connection

Field	Optional	Default	Multiple	Notes	Example
type	No	-	No	The value must be "smb".	"smb"
description	No	-	No	Name of the connection object.	"smbConnection"
credential	No	-	No	The id of the credential to be used with this seed. The credential type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
hostname	No	-	No	Hostname where the shared directory is located.	"shared.example.com"
port	No	445	No	Port where the SMB protocol is used.	"445"
properties	No	-	No	Configuration object
disableFetch	Yes	false	No	Check to disable the connector fetcher, only metadata will be collected.	true / false
verboseSMBJ	Yes	false	No	Check to enable SMBJ logging. (WARNING) Enabling this would decrease performance.	true / false
stopOnScanError	Yes	true	No	If enabled, the crawl will stop if there is an error on the scan phase.	true / false
indexContainers	Yes	false	No	Enable to index the directories.	true / false
scanRecursively	Yes	true	No	Enable to scan discovered directories recursively.	true / false
include	Yes	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be included in the crawl.	[ ".pdf$", ".docx$" ]
exclude	Yes	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be excluded from the crawl.	[ ".png$", ".jpeg$" ]
scanExcludedItems	Yes	false	No	Enable to force the scan of excluded directories, so child items within the scope can be found.	true / false
fetchACLs	Yes	true	No	Check to retrieve owner, group and ACL information.	true / false
resolveSIDs	Yes	true	No	Check to resolve retrieved SIDs from owner, group and ACL.	true / false
addACLSID	Yes	false	No	Check to include SID value on ACL output.	true / false
addACLEncodedSID	Yes	false	No	Check to include Encoded SID (Base 32) value on ACL output.	true / false
addACLFlags	Yes	false	No	Check to include ACL flags on ACL output.	true / false
addACLType	Yes	false	No	Check to include ACL type on ACL output.	true / false
addACLAccessMask	Yes	false	No	Check to include ACL access mask on ACL output.	true / false
enableDFS	Yes	true	No	Distributed File System (DFS) resolution	true /false
connectionTimeout	No	6000	No	Timeout in milliseconds for each smb request.	"6000"
maxRetries	No	5	No	Maximum retries permitted per document.	"5"
baseBackoff	No	500	No	Base time for the backoff sleeps (in ms).	"500"
backoffMultiplier	No	2.0	No	Multiplier factor to be used for the backoff time.	"2.0"
lastAccessedUpdates	Yes	false	No	Check to restore the last accessed date on the documents processed by the connector. WARNING: Requires a user with permissions for writing. This is not supported by windows.	true /false
staticAcl	Yes	[ ]	Yes	Static ACL configuration object
name	No	-	No	Name of the static ACL.	"group1"
domain	Yes	""	No	Domain of the static ACL.	"testDomain"
entity	Yes	"user"	No	Entity (user / group) represented by the static ACL.	"user" / "group"
access	Yes	"allow"	No	Access (allow / deny) granted by the ACL.	"allow" / "deny"

Example

Code Block

theme	RDark
title	POST aspire/_api/connections

{
    "type": "smb",
    "description": "SMB Test Connector",
	"credential": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "properties": {
        "host": "192.168.0.80",
        "port":"445",
        "disableFetch": false,
        "verboseSMBJ": false,
        "stopOnScanError": true,
        "indexContainers": true,
        "scanExcludedItems": true,
        "includes": ".*\\.txt",
        "excludes": ".*\\.png",
		"fetchACLs":true,
        "resolveSIDs": true,
		"addACLSID": false,
		"addACLEncodedSID": false,
		"addACLFlags": false,
		"addACLType" : false,
		"addACLAccessMask": false,
		"enableDFS": true,
		"connectionTimeout": 60000,
		"maxRetries": 5,
		"baseBackoff": 500,
		"backoffMultiplier": 2.0,
		"lastAccessedUpdates": false,
        "staticAcl": [{
                "name": "test-user",
                "domain": "test-domain",
                "entity": "user",
                "access": "allow"
            }, {
                "name": "test-group",
                "domain": "",
                "entity": "group",
                "access": "deny"
            }
        ]
    }
}

Update Connection

Field	Optional	Default	Multiple	Notes	Example
Field	Optional	Default	Multiple	Notes	Example
type	No	-	No	The value must be "smb".	"smb"
description	No	-	No	Name of the connection object.	"smbConnection"
credential	No	-	No	The id of the credential to be used with this seed. The credential type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
hostname	No	-	No	Hostname where the shared directory is located.	"shared.example.com"
port	No	445	No	Port where the SMB protocol is used.	"445"
properties	No	-	No	Configuration object
disableFetch	Yes	false	No	Check to disable the connector fetcher, only metadata will be collected.	true / false
verboseSMBJ	Yes	false	No	Check to enable SMBJ logging. (WARNING) Enabling this would decrease performance.	true / false
stopOnScanError	Yes	true	No	If enabled, the crawl will stop if there is an error on the scan phase.	true / false
indexContainers	Yes	false	No	Enable to index the directories.	true / false
scanRecursively	Yes	true	No	Enable to scan discovered directories recursively.	true / false
include	Yes	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be included in the crawl.	[ ".pdf$", ".docx$" ]
exclude	Yes	[ ]	Yes	Patterns to match against document URL, if any of them match, the document will be excluded from the crawl.	[ ".png$", ".jpeg$" ]
scanExcludedItems	Yes	false	No	Enable to force the scan of excluded directories, so child items within the scope can be found.	true / false
fetchACLs	Yes	true	No	Check to retrieve owner, group and ACL information.	true / false
resolveSIDs	Yes	true	No	Check to resolve retrieved SIDs from owner, group and ACL.	true / false
addACLSID	Yes	false	No	Check to include SID value on ACL output.	true / false
addACLEncodedSID	Yes	false	No	Check to include Encoded SID (Base 32) value on ACL output.	true / false
addACLFlags	Yes	false	No	Check to include ACL flags on ACL output.	true / false
addACLType	Yes	false	No	Check to include ACL type on ACL output.	true / false
addACLAccessMask	Yes	false	No	Check to include ACL access mask on ACL output.	true / false
enableDFS	Yes	true	No	Distributed File System (DFS) resolution	true /false
connectionTimeout	No	6000	No	Timeout in milliseconds for each smb request.	"6000"
maxRetries	No	5	No	Maximum retries permitted per document.	"5"
baseBackoff	No	500	No	Base time for the backoff sleeps (in ms).	"500"
backoffMultiplier	No	2.0	No	Multiplier factor to be used for the backoff time.	"2.0"
lastAccessedUpdates	Yes	false	No	Check to restore the last accessed date on the documents processed by the connector. WARNING: Requires a user with permissions for writing. This is not supported by windows.	true /false
staticAcl	Yes	[ ]	Yes	Static ACL configuration object
name	No	-	No	Name of the static ACL.	"group1"
domain	Yes	""	No	Domain of the static ACL.	"testDomain"
entity	Yes	"user"	No	Entity (user / group) represented by the static ACL.	"user" / "group"
access	Yes	"allow"	No	Access (allow / deny) granted by the ACL.	"allow" / "deny"

Example

Code Block

theme	RDark
title	PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0

{
    "type": "smb",
    "description": "SMB Test Connector",
	"credential": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "properties": {
        "host": "192.168.0.80",
        "port":"445",
        "disableFetch": false,
        "verboseSMBJ": false,
        "stopOnScanError": true,
        "indexContainers": true,
        "scanExcludedItems": true,
        "includes": ".*\\.txt",
        "excludes": ".*\\.png",
		"fetchACLs":true,
        "resolveSIDs": true,
		"addACLSID": false,
		"addACLEncodedSID": false,
		"addACLFlags": false,
		"addACLType" : false,
		"addACLAccessMask": false,
		"enableDFS": true,
		"connectionTimeout": 60000,
		"maxRetries": 5,
		"baseBackoff": 500,
		"backoffMultiplier": 2.0,
		"lastAccessedUpdates": false,
        "staticAcl": [{
                "name": "test-user",
                "domain": "test-domain",
                "entity": "user",
                "access": "allow"
            }, {
                "name": "test-group",
                "domain": "",
                "entity": "group",
                "access": "deny"
            }
        ]
    }
}

Create Connector

For the creation of the Connector object using the Rest API check this page

Update Connector

For the update of the Connector object using the Rest API check this page

Create Seed

Field	Optional	Default	Multiple	Notes	Example
seed	No	-	No	Path to the element to be crawled, can be a directory or a file.	"myDirectory/levelTwo"
type	No	-	No	The value must be "filesystem".	"smb"
description	No	-	No	Name of the seed object.	"MySMB"
seedFile	Yes	false	No	If checked the path will be processed as a file instead of a directory. WARNING: The crawler will only process the seed and then will stop.	true /false
connector	No	-	No	The id of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	No	-	No	The id of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	Yes	[ ]	Yes	The ids of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	Yes	-	No	Id of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	Yes	[ ]	Yes	The ids of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
tags	Yes	[ ]	Yes	The tags of the seed. These can be used to filter the seed	["tag1", "tag2"]

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

{
    "type": "smb",
    "seed": "myDirectory/levelTwo",
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "description": "FileSystem_Test_Seed",
    "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
    "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag1", "tag2"],
    "properties": {
        "seedFile": false
    }
}

Update Seed

Field	Optional	Default	Multiple	Notes	Example
id	No	-	No	Id of the seed to update.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
seed	Yes	-	No	The subdirectory to crawl. This value will be appended to the url of the connection.	"myDirectory/levelTwo"
description	Yes	-	No	Name of the seed object.	"MySMB"
seedFile	Yes	false	No	If checked the path will be processed as a file instead of a directory. WARNING: The crawler will only process the seed and then will stop.	true /false
connector	Yes	-	No	The id of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	Yes	-	No	The id of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	Yes	[ ]	Yes	The ids of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.add	Yes	[ ]	Yes	The ids of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove	Yes	[ ]	Yes	The ids of the workflows to remove.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	Yes	-	No	Id of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	Yes	[ ]	Yes	The ids of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.add	Yes	[ ]	Yes	The ids of the routingPolicies to add.	["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.remove	Yes	[ ]	Yes	The ids of the routingPolicies to remove.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]
tags	Yes	[ ]	Yes	The tags of the seed. These can be used to filter the seed	["tag1", "tag3"]
tags.add	Yes	[ ]	Yes	The tags to add	["tag4"]
tags.remove	Yes	[ ]	Yes	The tags to remove	["tag2"]

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
    "id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
    "type": "smb",
    "seed": "myDirectory/levelTwo",
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "description": "FileSystem_Test_Seed",
    "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
    "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag", "tag2"],
    "properties": {
        "seedFile": false
    }
}

Create Credential

Field	Optional	Default	Multiple	Notes	Example
type	No	-	No	The value must be "smb".	"smb"
description	No	-	No	Name of the credential object.	"smbCredential"
domain	Yes	-	No	Domain of the account that will crawl the shared directory. If the user is a local account leave blank	"WORKGROUP"
username	No	-	No	Account user	"admin"
password	No	-	No	Account password	"234dfc22re!?"

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "smb",
    "description": "SMB snapshot",
    "properties": {
        "username": "test",
        "password": "test1",
        "domain":"WORKGROUP"
    }
}

Update Credential

Field	Optional	Default	Multiple	Notes	Example
type	No	-	No	The value must be "smb".	"smb"
description	No	-	No	Name of the credential object.	"smbCredential"
domain	Yes	-	No	Domain of the account that will crawl the shared directory. If the user is a local account leave blank	"WORKGROUP"
username	No	-	No	Account user	"admin"
password	No	-	No	Account password	"234dfc22re!?"

Example

Code Block

theme	RDark
title	PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
    "type": "smb",
    "description": "SMB snapshot",
    "properties": {
        "username": "test",
        "password": "test1",
        "domain":"WORKGROUP"
    }
}

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Create Credential

Example

Update Credential

Example

Page tree

Page History

Versions Compared

Old Version 3

New Version 4

Key

Create Connection

Example

Update Connection

Example

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Create Credential

Example

Update Credential

Example