General
XpoLog SDK provides a set of commands that enables remote configuration of different XpoLog properties without accessing the GUI.
The following commands are available
...
Key | Description | Values |
| |||
api | The API type to use – must be addSyncLogTask | “addSyncLogTask” | Mandatory | |||
name | The name of the task | Text | Mandatory | |||
configFilePath | The absolute path to the LogSync configuration file to be used by this task | Text | Mandatory | |||
createConfiguration | Determines whether to create Folders and Logs configuration from the synched logs (Default: false) | true/false | Optional | |||
parentFolderPath | The parent folder path of this task’s result. Folder and Logs is the default path. | Use ‘->’ in the path between folders | Optionaloverride | |||
Override an existing task (Default: false) | true/false | Optional | cron | Unix cron expression format | cron expression format | Optional |
assignedNode | The name of the XpoLog node to be assigned on this task | Text | Optional | |||
override | Override an existing task (Default: false) | true/false | Optional |
Example of adding a Log Sync task:
...
Key | Description | Values |
|
api | The API type to use – must be addLog | “addLog” | Mandatory |
| logName | The name of the log to be created | Text | Mandatory |
| logPath | The full path to the log under the Folders and Log Tree (excluding the log name) | ROOT = Top Folder (Folders and Logs) Use ‘->’ in the path between folders | Optional |
filesPath | The full path to the files on the source (name pattern may be used) | Text | Mandatory |
| accountName | The name of the account to be used if needed (SSH or Win Account) | Text | Optional |
| timezone | The timezone definition of the added log | Text (a value from JAVA time zone list) | Optional |
| charset | The charset definition of the added log | Text (a value from JAVA charset list) | Optional |
| template | The name of the template to be used | Text | Mandatory |
override | Override an existing task (Default: false) | true/false | Optional |
Example for adding a log over SSH using an existing account (for direct access simple remove the -accountName parameter):
...