Versions Compared

Key

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

You can issue commands to start or stop running the DataSync Agent for ServiceNow from a command line interface on supported Windows and Linux devices

(info) NOTE: Enhanced integration with various security options provided by our supported OS platforms may result in the user receiving additional prompts for Administrator or SUDO permission. 

Info
Users MUST install and run the Agent as an Administrator in Windows or with sudo in Linux.



Prerequisites


(warning) First, you will need to install the DataSync Agent.


Linux 


Running your DataSync Agent in the Foreground 

Start

Execute the following command to start running your DataSync Agent:

Code Block
languagebash
themeEclipse
 ./runConsole.sh 

Stop 

Execute the following keys to stop running your DataSync Agent:

Code Block
languagebash
themeEclipse
	Ctrl+C

(warning) WARNINGWhen running the agent interactively in the foreground through runConsole.sh, it is advised to always terminate the Agent as documented below with Ctrl+C. This allows the interactive agent session to exit gracefully. Failure to do so may result in a lingering Java process which must be killed or terminated manually.


Running your DataSync Agent in the Background

Install

Running your DataSync Agent in the background will require you to install your DataSync Agent as a service first. 

Execute the following command to initiate an install of the Agent service: 

Code Block
languagebash
themeEclipse
	./installDaemon.sh 

Start

Execute the following command to start running your DataSync Agent:

Code Block
languagebash
themeEclipse
	./startDaemon.sh

Stop

Execute the following command to stop running your DataSync Agent:

Code Block
languagebash
themeEclipse
	./stopDaemon.sh

Uninstall

Execute the following command to uninstall the Agent service:

Code Block
languagebash
themeEclipse
	./uninstallDaemon.sh



Windows


Running your DataSync Agent in the Foreground

Start

Double-click the following file in the bin folder to initiate the running of your DataSync Agent:

Code Block
languagebash
themeEclipse
agent.bat

Stop

Execute the following keys to stop running your DataSync Agent:

Code Block
languagebash
themeEclipse
Ctrl+C

(warning) WARNINGWhen running the agent interactively in the foreground through Agent.bat, it is advised to always terminate the Agent as documented below with Ctrl+C. This allows the interactive agent session to exit gracefully. Failure to do so may result in a lingering Java process which must be killed or terminated manually.


Running your DataSync Agent in the Background

Install

Running your DataSync Agent in the background will require you to install your DataSync Agent as a service first. 

Double-click the following file in the bin folder to initiate an install of the Agent service: 

Code Block
languagebash
themeEclipse
	installService.bat

Start

Double-click the following file in the bin folder to initiate the running of your DataSync Agent:

Code Block
languagebash
themeEclipse
	startService.bat

Stop

Double-click the following file in the bin folder to stop the running of your DataSync Agent:

Code Block
languagebash
themeEclipse
	stopService.bat

Uninstall

Double-click the following file in the bin folder to uninstall the Agent service:

Code Block
languagebash
themeEclipse
	uninstallService.bat