Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
  • Add Folder
  • Remove existing folder/log

...

$JAVA_RUN $XPOLOG_CONN -api addLog -logName "LOG_NAME" -logPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "/var/log/messages{string}" -accountName "REMOTE_SOURCE_ACCOUNT" -template "LOG_TEMPLATE_NAME"

 


Add Folder

Key

Description

Values

 

api

The API type to use – must be addFolder

addFolder

Mandatory

folderPath

The full path to the folder to be removed

ROOT = Top Folder (Folders and Logs) Use ‘->’ in the path between folders

Mandatory

Example for removing a folder (and all its contents):

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api addFolder -folderPath "ROOT->FOLDER_1->FOLDER_2->FOLDER_NAME_TO_BE_ADDED"

Linux:

$JAVA_RUN $XPOLOG_CONN -api addFolder -folderPath "ROOT->FOLDER_1->FOLDER_2->FOLDER_NAME_TO_BE_ADDED"



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

Example for removing a folder (and all its contents):

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2->FOLDER_NAME_TO_BE_REMOVED"

Linux:

$JAVA_RUN $XPOLOG_CONN -api removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2->FOLDER_NAME_TO_BE_REMOVED"


Remove Log

Key

Description

Values

 

api

The API type to use – must be removeMember

“removeMember”

Mandatory

logPath

The full path to the log to be removed

ROOT = Top Folder (Folders and Logs) Use ‘->’ in the path between folders

Mandatory

...