Page Comparison

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

ConnectionXpoLog SDK

Settings

• Ports (HTTP, SSL, SHUTDOWN and AJP)
• Enable/Disable Security
• Enable/Disable Agent Mode

Security

• Add/Edit user

Accounts Management

• Add/Edit/Remove/Enable/Disable remote XpoLog account
• Add/Edit/Remove/Enable/Disable SSH account

Tasks Management

• Add/Edit/Execute Add Logs Directory task
• Add/Edit/Execute LogSync task

Folders and Logs Management

• Add Log
• Remove existing folder/log

System Advanced Properties Modifications

RestartXpoLog SDK

Apply License

Apply Patch

Requirements

• XpoLog Client Jar (download here)
• JAVA on client machine that executes the commands
• Connectivity (HTTP/S) between the client machine that executes the commands to the XpoLog server

Syntax

Anchor
Connection Connection

 Connection

In order to execute remote commands it is first required to provide connection parameters to the XpoLog instance:

...

java -cp xpologClient.jar com.xpolog.sdk.client.XpoLogSDKClient -xpologURL http http://<xpolog-machine>:<xpolog-port>/logeye -user USER USER_NAME -password PASSWORD PASSWORD

When using scripts, it is recommended to set the above as parameters, as they should be used on any command which is being executed:

...

set XPOLOG_CONN=-xpologURL http http://<xpolog-machine>:<xpolog-port>/logeye -user USER USER_NAME -password PASSWORD PASSWORD

Linux:

JAVA_RUN=”java -cp xpologClient.jar com.xpolog.sdk.client.XpoLogSDKClient”

XPOLOG_CONN=”-xpologURL http http://<xpolog-machine>:<xpolog-port>/logeye -user USER USER_NAME -password PASSWORD” PASSWORD”

After a connection is established the following command may be executed against the connected XpoLog instance:

General Settings and Security Commands

Anchor
Settings Settings

Settings Parameters

...

%JAVA_RUN% %XPOLOG_CONN% -api settings  settings -httpPort 30304  30304 -sslPort 30444  30444 -ajpPort 8010  8010 -shutdownPort 8096  8096 -agentMode true agentMode true -activateSecurity true  true

Linux:

$JAVA_RUN $XPOLOG_CONN -api settings  settings -httpPort 30304  30304 -sslPort 30444  30444 -ajpPort 8010  8010 -shutdownPort 8096  8096 -agentMode true agentMode true -activateSecurity true true

Anchor
Security Security

 Security Users Parameters

...

%JAVA_RUN% %XPOLOG_CONN% -api securityUsers  securityUsers -name testUser  testUser -userPassword testPassword  testPassword -displayName "TEST USER" -override true  true -userPolicy test  test -selectedGroupsList testgroup testgroup;All

Linux:

$JAVA_RUN $XPOLOG_CONN -api securityUsers  securityUsers -name testUser  testUser -userPassword testPassword  testPassword -displayName "TEST USER" -override true  true -userPolicy test  test -selectedGroupsList testgroup testgroup;All

...

Anchor
Accounts Accounts

Accounts Management

Remove Account

Example of applying a licenseExample of removing an account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api license -files license.lic

Restart Parameters

...

Key

...

Description

...

Values

...

...

 removeAccount -name "ACCOUNT_NAME"

Linux:

$JAVA_RUN $XPOLOG_CONN -api removeAccount -name "ACCOUNT_NAME"

Disable/Enable Account

Example of restarting XpoLogdisabling an account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api restart enableAccount -name "ACCOUNT_NAME" -enabled false

Linux:

$JAVA_RUN $XPOLOG_CONN CONN -api restart

...

 enableAccount -name "ACCOUNT_NAME" -enabled false

Add SSH Account Parameters

Example of applying a patch:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api addPatch -type api -files patch.zip

Linux:

$JAVA_RUN $XPOLOG_CONN -api addPatch -type api -files patch.zip

Accounts Management

Remove Account

...

Example for adding an SSH account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api removeAccount  addSSHAccount -name "ACCOUNT_NAME"

Linux:

$JAVA_RUN $XPOLOG_CONN -api removeAccount -name "ACCOUNT_NAME"

Disable/Enable Account

Example of disabling an account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api enableAccount -name "ACCOUNT_NAME" -enabled false

Linux:

$JAVA_RUN $XPOLOG_CONN -api enableAccount -name "ACCOUNT_NAME" -enabled false

Add SSH Account Parameters

...

Key

...

Description

...

Values

...

...

api

...

The API type to use – must be addSSHAccount

...

“addSSHAccount”

...

Mandatory

...

name

...

The name of the account

...

Text

...

Mandatory

...

hostName

...

Host Name

...

Text

...

Mandatory for new

...

conType

...

The connection type (Default: SFTP)

...

SFTP/SCP

...

Optional

...

override

...

 -hostName MACHINE_IP -conType SFTP -port 22 -override true -enabled true -privateKeyPath "" -username USER_NAME -userPassword PASSWORD

Linux:

$JAVA_RUN $XPOLOG_CONN -api addSSHAccount -name "ACCOUNT_NAME" -hostName MACHINE_IP -conType SFTP -port 22 -override true -enabled true -privateKeyPath "" -username USER_NAME -userPassword PASSWORD

Add Remote XpoLog Account Parameters

Example for adding an SSH of adding a remote XpoLog account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api addSSHAccount  addRemoteXpoLogAccount -name "ACCOUNT_NAME" -hostName MACHINE_IP -conType SFTP  HTTP -port 22  30303 -context logeye -override true -enabled true -privateKeyPath "" isCollected true -username USER_NAME  admin -userPassword PASSWORD admin

Linux:

$JAVA_RUN $XPOLOG_CONN CONN -api addSSHAccount  addRemoteXpoLogAccount -name "ACCOUNT_NAME" -hostName MACHINE_IP -conType SFTP  HTTP -port 22 -override 30303 -context logeye -override true -enabled true -privateKeyPath "" isCollected true -username USER_NAME  admin -userPassword PASSWORD

...

 admin

Anchor
Tasks Tasks

Tasks Management

Execute Task Parameters

Example of adding a remote XpoLog account:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api addRemoteXpoLogAccount -name "ACCOUNT_NAME" -hostName MACHINE_IP -conType HTTP -port 30303 -context logeye -override true -enabled true -isCollected true -username admin -userPassword admin

Linux:

$JAVA_RUN $XPOLOG_CONN -api addRemoteXpoLogAccount -name "ACCOUNT_NAME" -hostName MACHINE_IP -conType HTTP -port 30303 -context logeye -override true -enabled true -isCollected true -username admin -userPassword admin

Tasks Management

Execute Task Parameters

Example for executing a task:

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api executeTask -name "TASK_NAME"

Linux:

$JAVA_RUN $XPOLOG_CONN -api executeTask -name "TASK_NAME"

Execution of a Logs Directory Task (Scanner)

Example of executing a scan directory operation:

Windows: executeScanTask -name "sdkpizza6" -parentFolderPath "ROOT->pizza6" -scanPath "/home/xplg/xpologConfig/log/UI1" 

%JAVA_RUN% %XPOLOG_CONN% -api executeScanTask -name "SCANNER_SDK" -id "SCAN12345" -parentFolderPath "ROOT->NEW_PARENT_FOLDER" -accountName ACCOUNT_NAME -scanPath "/var/log/" -scanMethod 0 -timeZone GMT -directoriesToInclude "DIR1,DIR2" -filesToExclude "*.zip,*.gzip,*.tar*"

Linux: :

$JAVA_RUN $XPOLOG_CONN -api executeScanTask -name "SCANNER_SDK" -id "SCAN12345" -parentFolderPath "ROOT->NEW_PARENT_FOLDER" -accountName ACCOUNT_NAME -scanPath "/var/log/" -scanMethod 0 -timeZone GMT -directoriesToInclude "DIR1,DIR2" -filesToExclude "*.zip,*.gzip,*.tar*"

...

Example for executing a task:

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api executeTask -name "TASK_NAME"

Linux:

$JAVA_RUN $XPOLOG_CONN -api executeTask -name "TASK_NAME"

Execution of a Logs Directory Task (Scanner)

Example of executing a scan directory operation:

Windows: executeScanTask -name "sdkpizza6" -parentFolderPath "ROOT->pizza6" -scanPath "/home/xplg/xpologConfig/log/UI1" 

%JAVA_RUN% %XPOLOG_CONN% -api executeScanTask -name "SCANNER_SDK" -id "SCAN12345" -parentFolderPath "ROOT->NEW_PARENT_FOLDER" -accountName ACCOUNT_NAME -scanPath "/var/log/" -scanMethod 0 -timeZone GMT -directoriesToInclude "DIR1,DIR2" -filesToExclude "*.zip,*.gzip,*.tar*"

Linux: :

$JAVA_RUN $XPOLOG_CONN -api executeScanTask -name "SCANNER_SDK" -id "SCAN12345" -parentFolderPath "ROOT->NEW_PARENT_FOLDER" -accountName ACCOUNT_NAME -scanPath "/var/log/" -scanMethod 0 -timeZone GMT -directoriesToInclude "DIR1,DIR2" -filesToExclude "*.zip,*.gzip,*.tar*"

Add Log Sync Task Parameters

Example of adding a Log Sync task:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api addSyncLogTask -name "New Log Sync Test" -configFilePath C:\dev\syncLogsTest.xml -override true  -cron "0/10 * * * * ? *"

Linux:

$JAVA_RUN $XPOLOG_CONN -api addSyncLogTask -name "New Log Sync Test" -configFilePath C:\dev\syncLogsTest.xml -override true  -cron "0/10 * * * * ? *"

Anchor
FoldersandLogs FoldersandLogs

Folders and Logs Management

Add Log

Example of adding a Log Sync task:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api addSyncLogTask -name "New Log Sync Test" -configFilePath C:\dev\syncLogsTest.xml -override true  -cron "0/10 * * * * ? *"

Linux:

$JAVA_RUN $XPOLOG_CONN -api addSyncLogTask -name "New Log Sync Test" -configFilePath C:\dev\syncLogsTest.xml -override true  -cron "0/10 * * * * ? *"

Folders and Logs Management

Add Log

...

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 -logName "LOG_NAME" -logPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -patterns " {date:Date,dd/MM/yyyy HH:mm:ss.SSSSSS} {text:priority} {string:message}XPLG_SDK_SEP{date:Date,dd/MM/yyyy HH:mm:ss.SSS} {text:priority} {string:message}" -appTags "APP_TAG_NAME_1,APP_TAG_NAME_2"

%JAVA_RUN% %XPOLOG_CONN% -api addLog -logName "LOG_NAME" -logPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -template "LOG_TEMPLATE_NAME"

Linux:

$JAVA_RUN $XPOLOG_CONN -api addLog -logName "LOG_NAME" -logPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -patterns " {date:Date,dd/MM/yyyy HH:mm:ss.SSSSSS} {text:priority} {string:message}XPLG_SDK_SEP{date:Date,dd/MM/yyyy HH:mm:ss.SSS} {text:priority} {string:message}" -appTags "APP_TAG_NAME_1,APP_TAG_NAME_2"

$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"

Remove Folder

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

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api addLog  removeMember -logName "LOG_NAME" -logPath folderPath "ROOT->FOLDER_1->FOLDER_2->FOLDER_NAME_TO_BE_REMOVED"

Linux:

$JAVA_RUN $XPOLOG_CONN -api removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -patterns " {date:Date,dd/MM/yyyy HH:mm:ss.SSSSSS} {text:priority} {string:message}XPLG_SDK_SEP{date:Date,dd/MM/yyyy HH:mm:ss.SSS} {text:priority} {string:message}" -appTags "APP_TAG_NAME_1,APP_TAG_NAME_2"->FOLDER_NAME_TO_BE_REMOVED"

Remove Log

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

Windows: 

%JAVA_RUN% %XPOLOG_CONN% -api addLog -logName "LOG_NAME" -logPath  removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -template "LOG_TEMPLATE_NAME->LOG_NAME_TO_BE_REMOVED"

Linux:

...

$JAVA_RUN $XPOLOG_CONN   -api addLog -logName "LOG_NAME" -logPath  removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2" -filesPath "c:\LogFiles\messages{string}" -patterns " {date:Date,dd/MM/yyyy HH:mm:ss.SSSSSS} {text:priority} {string:message}XPLG_SDK_SEP{date:Date,dd/MM/yyyy HH:mm:ss.SSS} {text:priority} {string:message}" -appTags "APP_TAG_NAME_1,APP_TAG_NAME_2"

$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"

->LOG_NAME_TO_BE_REMOVED"

Anchor
License License

License Parameters

Example of applying a license:

%JAVA_RUN% %XPOLOG_CONN% -api license -files license.lic

Anchor
Restart Restart

Restart Parameters

...

Example of restarting XpoLog:

Windows: 

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

Linux:

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

Remove Log

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

Windows: $JAVA_RUN $XPOLOG_CONN -api restart

Anchor
Patch Patch

Publish Patch Task Parameters

Example of applying a patch:

Windows:

%JAVA_RUN% %XPOLOG_CONN% -api removeMember -folderPath "ROOT->FOLDER_1->FOLDER_2->LOG_NAME_TO_BE_REMOVED" addPatch -type api -files patch.zip

Linux:

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

 addPatch -type api -files patch.zip

Comments:

1. Any value which contains the space character should be wrapped with “quotes”. For example if the display name of a user is TEST USER then it should wrapped with quotes as:
   ... -displayName "TEST USER" ...
2. General Script Example: download here

Common Use Case:

1. Automatically Add Servers to XpoLog:
   Automating the process of adding new servers to XpoLog, mainly in dynamic environments such as clouds where servers are constantly added and removed. The SDK provides full support so when a new machine is added, simply be a couple of commands the new server is added to XpoLog and the required logs are be collected and available for the users. See Script Example: download here
2. Automatically Remove / Disable Servers in XpoLog:
   
   1. Disable Server but keep data that was already collected
      If a server is removed from the environment but you wish to keep the data that was already collected by XpoLog from that server, simply disable the account of that specific server so XpoLog will not try to connect to it but will keep the data based on the retention policy.  See Script Example: download here
   2. Remove Server and data that was collected from it
      If a server is removed from the environment and you wish to remove it from XpoLog including all data then simply remove the account of that server and the folder which contains all its logs. See Script Example: download here

...