CLI Console

CLI Console is the command line interface for managing DataSpiderServer. CLI Console provides the following functions.

User Management
Execution of creating users, granting privileges, showing user information, etc.

Group Management
Execution of creating/deleting groups, showing group information, etc.

File / directory management
Execution of creating/moving/copying files or directories, modifying owner/group, etc.

Project Management
Execution of downloading/uploading projects, showing project information, etc.

Service Execution/Management
Executing script, showing list of services/scripts, etc.

Trigger control
Controlling the trigger.

System information
Showing process information, repository DB information,etc.

DataSpiderServer Operation/Management
Stopping/restarting DataSpiderServer, server migration(import/export), etc.

CLI Console commands includes commands which are only executable by the administrator(administrator commands) and commands executable by all users(user commands).Also, options of certain user commands are only executable by the administrator (administrator option).

Use "help" command to get the list of CLI Console commands.
Also, use "man" command for detailed information about the commands.
In the display of "help" and "man" command, administrator commands and administrator options are distinguished from user commands by "*" mark.

To start CLI Console

CLI Console includes Server CLI Console and Client CLI Console.Start each as follows.

Server CLI Console

Select $DATASPIDER_HOME/server/bin/CLI.exe(CLI in UNIX/Linux version).
CLI Console starts and automatically logs in as root user.

Client CLI Console

Select $DATASPIDER_HOME//client/bin/CLI.exe(CLI in UNIX/Linux version).

CLI Console starts, type the following information and press Enter key to log in.

Item name	Required / Optional	Description	Remarks
HOST	Optional	Specifies host name/IP address of the machine that DataSpiderServer operates on.	If omitted, the host name/IP address set in boot.properties is set.
PORT	Optional	Specifies the port number of DataSpiderServer.	If omitted, the port number set in boot.properties is set.
USER	Required	Specifies the user name.
PASSWD	Required	Specifies the password.

CLI Command List

Commands available in CLI Console server are listed below. Administrator commands and administrator options are distinguished from user commands by "*" mark.

Number	Command name	Description	Option
1	adaptertypes	Shows a list of available adapters
2	cd	Changes the current working directory
3	chgrp	Changes the group
4	chmod	Changes access authority mode
5	chown(*)	Changes the owner
6	cp	Copies files	-r, --recursive -f, --force
7	deploy	Registers projects to the server	-o, --owner -s, --shared
8	exit	Ends CLI Console
9	exp(*)	Exports Server Information	-G -u -d -g -e -t -c -p -a -m --group --user --service --gr --env --trigger --calendar --project --applog --mount --triggerstatus --project-latest-version
10	gc	Executes garbage collection
11	get	File Retrieval	-f, --force -r, --recursive
12	groupadd(*)	Adds groups
13	groupdel(*)	Deletes groups
14	groups	Shows a list of groups
15	grp	Global resource management and status view	-a, --all() -c, --clear() -t, --type
16	help	Shows Help
17	id	Shows information about users
18	imp(*)	Imports server information	-m, --merge --triggerstatus
19	kill	Requests to stop the process	-t, --timeout
20	lcd	Changes working directory on the local file system
21	license	Shows license information
22	lls	Show the list of local file system
23	lmkdir	Creates a directory on the local file system	-p, --parents
24	locale	Shows locale	-c, --client
25	lock	Locks files
26	lpage	Shows the contents of files in the local file system	-x, --xml -e, --encoding
27	lpwd	Shows the working directory
28	ls	Shows file list	-l -i, --inode -c -a, --all
29	man	Shows manuals
30	memstat	Shows memory information	-k, --kilo -m, --mega
31	mkdir	Creates directory	-p, --CreateParent
32	mount	Shows mount information and mounts the local file system with DataSpiderServer.	-l -m, --move
33	mv	Moves files	-f, --force
34	myprojects	Shows the list of projects that the current log-in user can refer to.
35	myservices	Shows the list of services (formerly: projectnames)
36	page	Shows files on DataSpiderServer	-x, --xml -e, --encoding
37	passwd	Changes the password
38	ping	Checks whether the server has started or not
39	printenv	Shows the list of environment variables	-k, --keyword
40	processcount	Views and sets the number of processes and scripts in progress	-m, --max -s, --set
41	prodl	Download the project to local system	-s, --shared -u, --user(*) -a, --all -v, --version -r, --recursive
42	prodel	Deletes the project.	-s, --shared -u, --user(*) -f, --force
43	proinfo	Shows the list of project information.	-s, --shared -u, --user(*) -v, --version -l, --script-list
44	proul	Uploads the project from local system	-e, --exist_project -s, --shared -u, --user(*)
45	ps	Shows scripts/processes	-a, --all() -u, --user() -t, --time
46	put	Puts files on DataSpiderServer	-f, --force -r, --recursive
47	pwd	Shows the working directory on DataSpiderServer
48	reconnect	Reconnects to DataSpiderServer
49	repository	Repository DB management	-t, --test() -c, --connection -r, --reconnection --cleanup()
50	run	Executes scripts	-w, --wait -t, --type --enable-type-switch
51	rm	Deletes files/directories	-r, --recursive -f, --force
52	scriptnames	Shows the list of script names
53	session(*)	Manages session information and shows status	-l, --detail -k, --kill
54	shutdown(*)	Stops and restarts DataSpiderServer	-r, --reboot
55	sleep	Stops for a certain period of time
56	su	Changes to another user	-
57	threadstat	Gets thread information	-v, --verbose
58	touch	Updates file/ directory modified time
59	trigger	Controls triggers	-e, --enable -d, --disable --all-enable --all-disable
60	umount	Detaches mount
61	uname	Shows system information
62	undeploy	Deletes registered project(services) from server.
63	unlock	Releases lock
64	useradd(*)	Adds users
65	userdel(*)	Deletes users
66	usergroup(*)	Registers to the group/removes from the group	-a, --add -d, --delete
67	usermod(*)	Updates user information
68	users	Shows the list of users registered on DataSpiderServer	-a, --all
69	versioninfo	Gets the version of the modules installed on DataSpiderServer .
70	who	Shows the client application identifier	-l, --long
71	whoami	Shows log-in name

Command information about wildcard

Wildcard can be specified in certain commands using "*"( asterisk).
[Supported Commands]

ls
Wildcard can be used in <path> of "ls [ -l ] [ -i ] [ -c ] [ <path> ... ]".
[Usage]
"Ls *","ls test *", etc.

cd
Wildcard can be used in <directory> of "cd [ <directory> ]".Arguments are passed to whatever matches first.
[Usage]
"Cd *", "cd test *", etc.

touch
Wildcard can be used in <path> of "touch <path>".The modified date/time of all paths that match will be updated.
[Usage]
"Touch *", "touch **/*" etc.

rm
Wildcard can be used in <path> of "rm [ -f ] [ -r ] <path>".All paths that match will be removed.
[Usage]
"Rm *. txt" , "rm **/*. txt", etc.

chmod
Wildcard can be used in <path> of "chmod <mode> <path>".The access mode of all paths that match will be changed.
[Usage]
"Chmod 777 *" , "chmod 777 test *", etc.

chown
Wildcard can be used in <path> of "chown <user> <path>".The owner of all paths that match will be changed.
[Usage]
"Chown user *" , "chown user test *", etc.

chgrp
Wildcard can be used in <path> of "chgrp <group> <path>".The group of all paths that match will be changed.
[Usage]
"Chgrp group *" , "chgrp group test *", etc.

lock
Wildcard can be used in <file> of "lock <file>".All files that match will be locked.
[Usage]
"Lock *" , "lock test *", etc.

uncock
Wildcard can be used in <file> of "unlock <file>".All files that match will be unlocked.
[Usage]
"Unlock *" , "unlock test *", etc.

cp
Wildcard can be used in <source_path> of "cp [ -r ] [ -f ] <source_path> <dest_path>".All paths that match will be selected and copied.
[Usage]
"cp *.txt tmp" , "cp **/* ../backup", etc.

mv
Wildcard can be used in <source_path> of "mv [ -f ] <source_path> <dest_path>".All paths that match will be selected and moved.
[Usage]
"mv *.txt tmp" , "mv **/* ../backup", etc.

CLI Batch

Commands are typically executed from CLI Console, yet they can also be executed from batch programs.

CLI.exe of Client CLI Console can not execute batch program.

CLI Batch Description

CLI -M<CLI command setting file>
1 2 3
1. Describes the path of CLI.exe by the absolute path, or the path relative to the directory where the batch program is placed.
2. For specifying the CLI command setting file.
3. Describes the path of the CLI command setting file.Specify the path following "-M" with no spacing.Describes the file path by the absolute path, or the path relative to the directory where the CLI batch is saved.
Description example: File name "CLI.bat"

C:\Progra~1\DataSpiderServista\server\bin\cli -MC:\TEMP\clicommand

Description of the CLI command setting file

Describes CLI commands in the file.
The following shows the process of moving to root directory"/", creating "WinTemp" directory and mount C:\TEMP to "/WinTemp" as an example.Lines beginning with "#" are treated as comments.

Description example: File name "clicommand"

cd /
# Creates a temporary directory.
mkdir WinTemp
# Mounts to WinTemp.
mount C:\TEMP /WinTemp 777

To start CLI batch

Execute the created batch program to start CLI batch.
Executing "CLI.bat" in the example above is equal to executing "cd /", "mkdir WinTemp", "mount C:\TEMP /WinTemp 777" in order with CLI Console.

Specification Limits

User logged in on Server CLI Console is fixed as root user.

Command chown cannot change the owner of the project.

When a relative path is specified in any command, the current working directory is "$DATASPIDER_HOME/<server|client>/bin".

Main exceptions

None.

Notes

Press Ctrl + C key to exit the CLI Console.

Although file name/directory name completion is not available, wildcard can be specified in some commands.

In case of copying or moving files/directories, when files/directories already exist in the destination, files/directories cannot be copied or moved unless f option is specified.

The following commands are not available when DataSpiderServer operates without repository DB.
- useradd
- groupadd
- chmod
- lock
- unlock
The following commands can only be performed by the administrator .
- passwd <user_id>
- repository -c reset
DataSpiderServer and CLI Console communicate in HTTPS when [Enable HTTPS] is checked in [Control Panel] - [DataSpiderServer Settings] - [Security] tab.

When a running trigger is disabled by trigger command, the running script containing the trigger will not be terminated.