...
<Account name="ACCOUNT NAME" useEncrypt="false" privateKeyPath="" isSystemAccount="false" isScriptApi="false" isSSH="true" isPublicKey="false" isEditable="true" isCertificate="false" description="" classKey="xpolog.eye.media.telsh.TelnetAccount" certificateId="" UserName="USERNAME" TYPE_SCP_SFTP="SFTP" Port="22" Password="PASSWORD" NetAddress="IP"/>
Note: you should not use an id parameter in the account line in the scanner XML. In case an account already exists in XpoLog then based on the NetAdress and Name it will be matched and re-used. In case the account does not exist it will be created during the scanner execution.
ScanDirectory Parameter
| Parameter | Mandatory/Optional | Description | Values |
|---|---|---|---|
| scanPath | Mandatory | The full path to the directory that is to be scanned | Path |
...
| Parameter | Mandatory/Optional | Description | Values | ||||
|---|---|---|---|---|---|---|---|
| condenseLogsTree | Optional | A "true" value indicates that folders containing only one subfolder sub-folder and without logs, will be omitted from the Folders and Logs Logs tree. | Boolean | ||||
| directoriesToHide | Optional | A comma separated list of name expressions of folders that will not be added to the Folders and Logs tree;their subfolderssub-folders/logs will be added. | |||||
| fileSuffixesToIgnore | Optional | Unite logs with different suffixes into one log type (advanced) | |||||
| numberOfThreads | Optional | The number of threads to be used as part of the scanning operation | Integer | ||||
| removeEmptyNodes | Optional | In case there are no matching files under one of the Folders and Logs members, remove it from the Folders and Logs tree. | Boolean | ||||
| subdirsScanLevel | Optional | The number of subdirectories sub-directories to scan from the given directory. Default is unlimited; any number can be specified. | Integer or "Unlimited" | ||||
| scanMethod | Optional | 0 = Use existing configuration (file names and content) and automatic matching. 1 = Use existing configuration (file names and content). 2 = Use existing configuration (file names only). | 0, 1, or 2 | ||||
| namePatternLogic | Optional | 0 = Capture each file separately (without name pattern). 1 = Unite files with a similar names (apply name pattern automatically). 2 = Unite files with a similar suffix (apply name pattern only at the end of the file name). | 0, 1, or 2 | ||||
| filesToInclude | Optional | Comma separated list of the files to capture during a scan; for example: *.txt, *Define which files to include in the log scan: Using wildcard: *.log,*.txt - include all files whose name ends with .log or .txt Using a regular expression: regexp:\w+\.log - include all files whose name is constructed of word characters only and ends with .log, for example helloWorld.log | |||||
| filesToExclude | OptionalComma | separated list of the files that will be skipped during a scan; for exampleDefine which files to exclude in the log scan: Using wildcard: *.txt, *.logzip,*.gz - exclude all files whose name ends with .zip or .gz Using a regular expression: regexp:\w+\.tar\.gz - exclude all files whose name is constructed of word characters only and ends with .tar.gz, for example helloWorld.tar.gz | |||||
| directoriesToExclude | Optional | Comma separated list of the directories that will be skipped during a scan; for example: DIR_NAME, *NAME* | |||||
| directoriesToInclude | Optional | Comma separated list of the only directories that will be included during a scan; for example: DIR_NAME, *NAME* | |||||
| Define which directories to exclude from the log scan: Using wildcard: Apps* - exclude all directories whose name starts with Apps Using a regular expression: regexp:\d\d\d\d-\d\d\-\d\d - exclude all directories whose name is a date, for example 2013-11-26 | |||||||
| directoriesToInclude | Optional | Define which directories to include in the log scan: Using wildcard: Apps* - include all directories whose name starts with Apps Using a regular expression: regexp:\d\d\d\d-\d\d\-\d\d - include all directories whose name is a date, for example 2013-11-26 | |||||
| templatesToUse | Optional | The scan task will add only logs which were matched to one of the comma separated list of specified templates. | String | ||||
| namePatternToApply | Optional | Automatically name the matched logs based on the given name pattern. Allowed identifiers are:
| String | ||||
| timeZone | Optional | Set the specified time zone on all matched logs | String | ||||
| onlineLogsApplication | Optional | Comma separated list of application name(s) that the online logs will be tagged to once created | String | ||||
| assignedCollectionPolicy | Optional | The policy name of the collection policy that will be applied on the logs once created; If the parameter does not exist - the default policy will be automatically applied. | String | ||||
| fileSuffixesToIgnore | Optional | Regular expression used to ignore part of the files names to define a name pattern | String | ||||
| enableLogsIndex* | Optional | True – Online logs that are added under Folders and Logs will be indexed. False – Disable indexing. | Boolean | ||||
| enableLogsAnalytics* | Optional | True – Online logs that are added under Folders and Logs will be analyzed by Analytics. False – Disable Analytics. | Boolean | ||||
| addCollectors* | Optional | True – All the logs that are added by the scanner task will be collected; default policy will be applied, unless a specific policy policy is specified. False – Disables logs collection. | Boolean | ||||
| enableCollectedLogsAnalytics* | Optional | True – enables Analytics analysis on collected logs. Online logs state will be taken from the collection policy; relevant only when addCollectors="true". False – Disables Analytics analysis on collected log. | Boolean | ||||
| enableCollectedLogsIndex* | Optional | True – enables indexing of collected logs. The online logs state will be taken from the collection policy; relevant only when addCollectors="true". False – Disables indexing of collected logs. | Boolean | ||||
| onlineLogsApplication | Comma separated list of application name(s) that the online logs will be tagged to once created | ||||||
| collectedLogsApplication* | OptionalOptional | Comma separated list of application name(s) that the collected logs will be tagged to once created; relevant only when addCollectors="true". | assignedCollectionPolicy | Optional | The policy name of the collection policy that will be applied on the logs once created; If the parameter does not exist - the default policy will be automatically applied. | String |
* Properties relevant only to versions 4.4 and below
...