CLI Console

CLI Consoleとは

CLI Consoleとは、DataSpiderServerを管理するためのコマンドラインインターフェースです。CLI Consoleが提供する機能は以下の通りです。 CLI Consoleで使用できるコマンドには、管理者のみが実行できるコマンド(管理者コマンド)とユーザなら誰でも実行できるコマンド(ユーザコマンド)があります。また、ユーザコマンドの中には管理者のみが指定できるオプション(管理者オプション)があります。

CLI Consoleのコマンドの一覧を取得したい場合には「help」コマンドを使用してください。
また、コマンドの詳細な情報を知りたい場合は、「man」コマンドを使用してください。
「help」コマンドや「man」コマンドの表示では、管理者コマンドや管理者オプションに「(*)」を付けてユーザコマンドと区別しています。

CLI Consoleの起動

CLI ConsoleにはServer CLI ConsoleとClient CLI Consoleがあります。それぞれの起動方法は以下の通りです。

Server CLI Console

  1. $DATASPIDER_HOME/server/bin/CLI.exe(UNIX/Linux版では「CLI」)を選択します。
  2. CLI Consoleが起動し、自動的にrootユーザでログインします。

Client CLI Console

  1. $DATASPIDER_HOME/client/bin/CLI.exe(UNIX/Linux版では「CLI」)を選択します。
  2. CLI Consoleが起動し、以下の情報を入力しEnterキー押下でログインします。

    項目名 必須/省略可 説明 備考
    HOST 省略可 DataSpiderServerが稼働するマシンのホスト名/IPアドレスを指定します。
    • 省略した場合、boot.propertiesに設定されているホスト名/IPアドレスが設定されます。
    PORT 省略可 DataSpiderServerのポート番号を指定します。
    • 省略した場合、boot.propertiesに設定されているポート番号が設定されます。
    USER 必須 ユーザ名を指定します。  
    PASSWORD 必須 パスワードを指定します。  

CLIコマンド一覧

CLI Consoleで使用できるコマンドは以下の通りです。管理者コマンドと管理者オプションには「(*)」を付与しています。

番号 コマンド名 説明 オプション
1 adaptertypes 使用可能なアダプタ一覧の表示  
2 cd 現在の作業用ディレクトリの変更  
3 chgrp グループの変更  
4 chmod アクセス権限モードの変更  
5 chown(*) 所有者の変更  
6 cp ファイルのコピー
  • -r, --recursive
  • -f, --force
7 deploy プロジェクトをサーバへ登録します
  • -o, --owner
  • -s, --shared
8 exit CLI Consoleの終了  
9 exp(*) サーバ情報のエクスポート
  • -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 ガベージコレクションの実行  
11 get ファイルの取得
  • -f, --force
  • -r, --recursive
12 groupadd(*) グループの追加  
13 groupdel(*) グループの削除  
14 groups グループの一覧表示  
15 grp グローバルリソースの管理および状態表示
  • -a, --all(*)
  • -c, --clear(*)
  • -t, --type
16 help ヘルプの表示  
17 id ユーザに関する情報の表示  
18 imp(*) サーバ情報のインポート
  • -m, --merge
  • --triggerstatus
19 kill プロセスの停止要求を行います
  • -t, --timeout
20 lcd ローカルファイルシステムでの作業ディレクトリの変更  
21 license ライセンス情報の表示  
22 lls ローカルファイルシステムの一覧表示  
23 lmkdir ローカルファイルシステムにディレクトリを作成
  • -p, --parents
24 locale ロケールの表示
  • -c, --client
25 lock ファイルのロック  
26 lpage ローカルファイルシステムにあるファイルの内容を表示
  • -x, --xml
  • -e, --encoding
27 lpwd 作業ディレクトリを表示  
28 ls ファイル一覧の表示
  • -l
  • -i, --inode
  • -c
  • -a, --all
29 man マニュアルの表示  
30 memstat メモリに関する情報の表示
  • -k, --kilo
  • -m, --mega
31 mkdir ディレクトリの作成
  • -p, --CreateParent
32 mount マウント情報の表示およびDataSpiderServerのローカルファイルシステムのマウント
  • -l
  • -m, --move
33 mv ファイルの移動
  • -f, --force
34 myprojects 現在ログイン中のユーザが参照できるプロジェクト一覧を表示します  
35 myservices サービスの一覧表示(旧:projectnames)  
36 page DataSpiderServerにあるファイルの表示
  • -x, --xml
  • -e, --encoding
37 passwd パスワードの変更  
38 ping サーバが起動しているかどうかを確認します  
39 printenv 環境変数の一覧表示
  • -k, --keyword
40 processcount 実行中のスクリプト・プロセス数の表示と設定
  • -m, --max
  • -s, --set
41 prodl プロジェクトをローカルにダウンロードします
  • -s, --shared
  • -u, --user(*)
  • -a, --all
  • -v, --version
  • -r, --recursive
42 prodel プロジェクトを削除します。
  • -s, --shared
  • -u, --user(*)
  • -f, --force
43 proinfo プロジェクトの情報を表示します
  • -s, --shared
  • -u, --user(*)
  • -v, --version
  • -l, --script-list
44 proul プロジェクトをローカルからアップロードします
  • -e, --exist_project
  • -s, --shared
  • -u, --user(*)
45 ps スクリプト・プロセスの表示
  • -a, --all(*)
  • -u, --user(*)
  • -t, --time
46 put DataSpiderServerにファイルを配置
  • -f, --force
  • -r, --recursive
47 pwd DataSpiderServer上での作業ディレクトリの表示  
48 reconnect DataSpiderServerへの再接続  
49 repository リポジトリDB管理
  • -t, --test(*)
  • -c, --connection
  • -r, --reconnection
  • --cleanup(*)
50 run スクリプトの実行
  • -w, --wait
  • -t, --type
  • --enable-type-switch
51 rm ファイル・ディレクトリの消去
  • -r, --recursive
  • -f, --force
52 scriptnames スクリプト名の一覧表示  
53 session(*) セッション情報を管理および状態表示
  • -l, --detail
  • -k, --kill
54 shutdown(*) DataSpiderServerの停止・再起動
  • -r, --reboot
55 sleep 一定時間の停止  
56 su 別のユーザへの変更
  • -
57 threadstat スレッド情報を取得
  • -v, --verbose
58 touch ファイル・ディレクトリの更新日時の変更  
59 trigger トリガーの制御を行います
  • -e, --enable
  • -d, --disable
  • --all-enable
  • --all-disable
60 umount mountの解除  
61 uname システム情報の表示  
62 undeploy サーバに登録したプロジェクト(サービス)をサーバから削除します  
63 unlock ロックの解除  
64 useradd(*) ユーザの追加  
65 userdel(*) ユーザの削除  
66 usergroup(*) グループへの登録・削除
  • -a, --add
  • -d, --delete
67 usermod(*) ユーザ情報の更新  
68 users DataSpiderServerに登録されているユーザの一覧表示
  • -a, --all
69 versioninfo DataSpiderServerにインストールされているモジュールのバージョンを取得します。  
70 who クライアントアプリケーション識別子の表示
  • -l, --long
71 whoami ログイン名の表示  

ワイルドカードに関するコマンド情報

一部のコマンドでは、「*」(アスタリスク)によるワイルドカード指定を使用することができます。
ワイルドカード指定に対応しているコマンドは、以下の通りです。；
  1. ls
    「ls [ -l ] [ -i ] [ -c ] [ <path> ... ]」の<path>にワイルドカードが使用できます。
    【使用方法】
    「ls *」・「ls test*」など

  2. cd
    「cd [ <directory> ]」の<directory>にワイルドカードが使用できます。最初にマッチしたものが引数に渡されます。
    【使用方法】
    「cd *」・「cd test*」など

  3. touch
    「touch <path>」の<path>にワイルドカードが使用できます。マッチしたすべてのパスの更新日時が更新されます。
    【使用方法】
    「touch *」・「touch **/*」など

  4. rm
    「rm [ -f ] [ -r ] <path>」の<path>にワイルドカードが使用できます。マッチしたすべてのパスが削除されます。
    【使用方法】
    「rm *.txt」・「rm **/*.txt」など

  5. chmod
    「chmod <mode> <path>」の<path>にワイルドカードが使用できます。マッチしたすべてのパスのアクセス権限モードが変更されます。
    【使用方法】
    「chmod 777 *」・「chmod 777 test*」など

  6. chown
    「chown <user> <path>」の<path>にワイルドカードが使用できます。マッチしたすべてのパスの所有者が変更されます。
    【使用方法】
    「chown user *」・「chown user test*」など

  7. chgrp
    「chgrp <group> <path>」の<path>にワイルドカードが使用できます。マッチしたすべてのパスのグループが変更されます。
    【使用方法】
    「chgrp group *」・「chgrp group test*」など

  8. lock
    「lock <file>」の<file>にワイルドカードが使用できます。マッチしたすべてのファイルがロックされます。
    【使用方法】
    「lock *」・「lock test*」など

  9. uncock
    「unlock <file>」の<file>にワイルドカードが使用できます。マッチしたすべてのファイルがロック解除されます。
    【使用方法】
    「unlock *」・「unlock test*」など

  10. cp
    「cp [ -r ] [ -f ] <source_path> <dest_path>」の<source_path>にワイルドカードが使用できます。マッチしたすべてのパスが選択され、コピーされます。
    【使用方法】
    「cp *.txt tmp」・「cp **/* ../backup」など

  11. mv
    「mv [ -f ] <source_path> <dest_path>」の<source_path>にワイルドカードが使用できます。マッチしたすべてのパスが選択され、移動されます。
    【使用方法】
    「mv *.txt tmp」・「mv **/* ../backup」など

CLIバッチについて

各コマンドは通常CLI Consoleから使用しますが、この各コマンドをバッチプログラムから実行することもできます。
Client CLI ConsoleのCLI.exeではバッチプログラムを実行することはできません。

仕様制限

主な例外

ありません。

注意事項