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
...
Folders and Logs Management
Add Log
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 |
| template | The name of the template to be used | Text | Mandatory |
Example for adding a log over SSH using an existing account (for direct access simple remove the -accountName parameter):
Windows:
%JAVA_RUN% %XPOLOG_CONN% -api addLog -folderPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "/var/log/messages{string}" -accountName "REMOTE_SOURCE_ACCOUNT" -template "LOG_TEMPLATE_NAME"
Linux:
$JAVA_RUN $XPOLOG_CONN -api addLog -folderPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "/var/log/messages{string}" -accountName "REMOTE_SOURCE_ACCOUNT" -template "LOG_TEMPLATE_NAME"
Remove Folder
Key | Description | Values |
|
api | The API type to use – must be removeMember | “removeMember” | Mandatory |
folderPath | The full path to the folder to be removed | ROOT = Top Folder (Folders and Logs) Use ‘->’ in the path between folders | Mandatory |
...