Field | Optional | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | No | - | No | Id of the credential to update | "89d6632a-a296-426c-adb0-d442adcab4b0" |
type | No | - | No | The value must be "filesystem". | "filesystem" |
description | No | - | No | Name of the connection object. | "MyFileSystemConnection" |
throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
properties | No | - | No | Configuration object | |
host | No | - | No | Name of the host where the smb share is located. | "share.example.com" |
port | Yes | 445 | No | Port where the smb protocol is listened. | 445 |
indexContainers | Yes | false | No | Enable to process directories as regular files. | true / false |
scanExcludedItems | Yes | false | No | Enable to scan directories previously excluded from the crawl. | true / false |
stopOnScanError | Yes | true | No | If enabled, the crawl will stop if there is an error on the scan phase. | true / false |
disableFetch | Yes | false | No | Disable the content fetcher, only metadata will be retrieved. | true / false |
verboseSMBJ | Yes | false | No | Log SMBJ library output. | true / false |
traceSMBJ | Yes | false | No | Log TRACE level messages. | 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$" ] |
fetchACLs | Yes | true | No | Enable to retrieve the document's ACL information. | true / false |
resolveSIDs | Yes | true | No | Enable to resolve the document Security Identifier (SID). | true / false |
addACLSID | Yes | false | No | Enable to add the SID to the ACL output. | true / false |
addACLEncodedSID | Yes | false | No | Enable to add the Base32 encoded SID to the ACL output. | true / false |
addACLFlags | Yes | false | No | Enable to add Access Control Entry flags to the ACL output. | true / false |
addACLType | Yes | false | No | Enable to add Access Control Entry type to the ACL output. | true / false |
addACLAccessMask | Yes | false | No | Enable to add the Access Control Entry access mask (hex value) to the ACL output. | true / false |
enableDFS | Yes | false | No | Enable Distributed File System (DFS) path resolution. | true / false |
connectionTimeout | Yes | 60000 | No | Timeout in milliseconds for establishing a connection with the server. | 60000 |
maxRetries | Yes | 5 | No | Times a request will be retried before reporting the error. | 5 |
baseBackoff | Yes | 500 | No | Initial time to wait before retrying a failed request | 500 |
backoffMultiplier | Yes | 2 | No | Multiplier for the backoff period before retrying a request | 1.5 |
lastAccessUpdate | Yes | false | No | If enabled, the connector will override the last access date of the documents with the value they had before the crawl. NOTE: Requires writing permission. | 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" |
$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")