概要
コマンドラインは、TeamFileサーバに対しての操作をWindowsのコマンドプロンプトやPowerShellを利用して実行することができるツール群です。
ダウンロード
| 種類 | ダウンロードURL |
|---|---|
| EXE | https://dl.teamfile.com/client/cmd/pkcmd-Setup-3.0.0.1.exe |
| ZIP | https://dl.teamfile.com/client/cmd/pkcmd-3.0.0.1.zip |
ファイル構成
pkusr(ユーザ管理)
ユーザの追加や更新などユーザ操作全般の操作を行います。
pkgrp(グループ管理)
共有グループの追加更新やユーザの所属などの操作を行います。
pkstat(ステータス管理)
全ユーザの状態を一覧として取得します。
pkput(ファイルアップロード)
ファイルのアップロードを行います。
pkget(ファイルの取得)
ファイルの取得を行います。
pklist(ファイルの一覧取得)
ファイルの取得を行います。
pkdel(ファイルの削除)
ファイルの削除を行います。
実行環境
コマンドラインは標準MBCSですので特に意識する必要はありませんが、UTF8でのみ表現できる文字コードの場合は文字化けやエラーを出力します。通常コンソールに表示できる文字は不正にはなりません。
セットアップ
動作環境の準備
コマンドラインツールが動作可能なWindows環境をご用意ください。プログラムは以下の場所から自由にダウンロードが行えます。
http://dl.teamfile.com/client/cmd/
インストール
ダウンロードしたexeをダブルクリックしてインストールしてください。 zip版は適当な場所に展開するだけで利用できます。
コマンドラインツール専用アカウントの作成
コマンドラインツールをご利用いただくためには、管理者権限を持つアクセスアカウント(Unixアカウントではありません)が必要となります。このアカウントはコマンドラインツールにのみお使い頂くことを推奨いたします。アカウントの作成には、専用クライアントをお使い下さい。
このユーザは後述致しますコマンドラインツールの引数または環境変数に指定して利用されます。
ユーザ操作コマンド
用途
- 新規ユーザの作成 (グループへの所属も同時に指定できます)
- ユーザ情報の更新 (グループへの所属も同時に指定できます)
- ユーザの削除
- ユーザ情報の取得
pkusrコマンドライン
Windows版(pkusr)
C:\Program Files\pkcmd\pkusr
インストールする場所によりprogram filesの場所が異なります。
コマンドライン共通オプション (モードに応じたオプション)
| パラメータ | 説明 |
|---|---|
| -U | 管理者ユーザのユーザID(環境変数:PKUSER)※1 |
| -P | 管理者ユーザのパスワード(環境変数:PKPASS) |
| -H | サーバのURL http://host.domain/location/(環境変数:PKHOST) |
| -T | ソケットタイムアウト |
| -G | プロキシホスト (-G ホスト名:ポート番号、-G autoで自動でProxyを調べます) |
| -L | 利用言語 [ ja | en ] (デフォルト :ja) |
| -X | プロキシユーザID |
| -Y | プロキシパスワード |
| -V | バージョン |
| -M | モード [ add | delete | update | view ]※2 |
| -O | 出力形式 [ xml | plain(デフォルト) ] |
| -Z | 圧縮受信を要求する(環境変数:PKCOMP=[true|false]) |
| -D | デバッグモード [ -D 出力ファイル名 ] |
| -S | クライアント証明書へのフルパス名 [ -S ファイルパス名 ] |
| -? | このヘルプを表示する |
モードに応じたオプション (ユーザの新規作成)
| パラメータ | 説明 |
|---|---|
| -a | アクセス権限(RW:フルアクセス, RO: 読み込み専用, UO:アップロード専用) (省略時:RW) |
| -b | リソース公開権限 [ on | off ](省略時:-z がnormal, adminであればあり) |
| -c | コメント (省略可) |
| -d | ユーザのアクティブ設定 [ active | inactive ] (省略時:active) |
| -e | 有効期限 ISO8601形式 (UTC) 書式: YYYY-MM-DDThh:mm:ssZ (省略可) |
| -f | ファイル数のリミット(省略時:無制限) |
| -g | 所属するグループをカンマ区切りで指定 (例: group1, group2) (省略可) |
| -i | 新規作成するユーザのユーザID(必須) |
| -l | アクセス制限(複数指定時にはカンマで区切って並べてください)(任意) ( user | group | db | repos | adm | adm-user | adm-group | adm-sql | adm-stat | adm-dbms | adm-update | adm-db-test | adm-msg | simple-user | simple-user-non-private | simple-admin )※4 |
| -n | ユーザ名(必須) |
| -m | メールアドレス(省略可) |
| -o | 他ユーザを管理する [ on | off ](省略可) (-z が groupleader の場合のみ有効、グループリーダ機能) |
| -p | パスワード(必須) |
| -r | 容量のリミット(省略時:無制限) |
| -t | グループ制約を受けない [on | off](グループ制約機能)(省略可) |
| -u | 作成可能なユーザ数 [ -u ユーザ数 | 0 (無制限)](省略可) (-z が groupleader の場合のみ有効、グループリーダ機能) |
| -w | 許可ホスト(カンマ区切り) |
| -z | ユーザの種類 [ admin | groupleader | normal | limited ]※3 (省略時:normal) |
モードに応じたオプション (ユーザの更新)
| パラメータ | 説明 |
|---|---|
| -a | アクセス権限(RW:フルアクセス, RO: 読み込み専用, UO:アップロード専用) (-s がある場合には省略可、-sが無い場合には省略するとデフォルト値※5) |
| -b | リソース公開権限 [ on | off ]※5 |
| -c | コメント※5 |
| -d | ユーザのアクティブ設定 [ active | inactive ] ※5 |
| -e | 有効期限 ISO8601形式 (UTC) 書式: YYYY-MM-DDThh:mm:ssZ※5 0で無期限 |
| -f | ファイル数のリミット ※5 |
| -g | 所属するグループをカンマ区切りで指定 (例: group1, group2) ※5 |
| -i | 更新するユーザのユーザID (必須) |
| -l | アクセス制限(複数指定時にはカンマで区切って並べてください)※5 ( user | group | db | repos | adm | adm-user | adm-group | adm-sql | adm-stat | adm-dbms | adm-update | adm-db-test | adm-msg | simple-user | simple-user-non-private | simple-admin )※4 |
| -n | ユーザ名 ※5 |
| -m | メールアドレス ※5 |
| -o | 他ユーザを管理する [ on | off ] (-z が groupleader の場合のみ有効、グループリーダ機能) |
| -p | パスワード ※5 |
| -r | 容量のリミット ※5 |
| -s | 指定されていないパラメータはサーバの値を利用 ※5 |
| -t | グループ制約を受けない [ on | off ](グループ制約機能) |
| -u | 作成可能なユーザ数 [ -u ユーザ数 | 0 (無制限)] (-z が groupleader の場合のみ有効、グループリーダ機能) |
| -w | 許可ホスト(カンマ区切り) |
| -z | ユーザの種類 [ admin | groupleader | normal | limited ]※3、※5 |
| -2 | 変更先ユーザID(更新専用)※6 |
モードに応じたオプション (ユーザの削除)
| パラメータ | 説明 |
|---|---|
| -i | 削除対象のユーザID |
| -q | 強制削除 |
モードに応じたオプション (ユーザ情報の表示)
| パラメータ | 説明 |
|---|---|
| -i | 情報を表示するユーザのユーザID |
| -v | ユーザのステータスだけを戻り値で取得する(省略可) |
※1: 環境変数について
幾つかの引数は、環境変数として設定しておくことで省略することができます。
| 環境変数名 | 意味 |
|---|---|
| PKUSER | コマンドラインを使ってサーバにアクセスするためのユーザID(文字列) 「3.4. コマンドラインツール専用アカウント作成」で作成したユーザIDを指定 |
| PKPASS | アクセスユーザのパスワード(文字列) 「3.4. コマンドラインツール専用アカウント作成」で作成したユーザのパスワード。 |
| PKHOST | アクセスするURL(文字列) |
| PKCOMP | サーバから受信するデータを圧縮して受信するかどうか(true / false) |
※2: 「モード」について
このコマンドラインは「モード」の指定により、複数の機能を使い分けることができます。
| モードの値 | 意味 |
|---|---|
| add | 新しいユーザの追加を指示する |
| delete | 指定されたユーザの削除を指示する |
| update | 指定されたユーザの更新を指示する |
| view | 指定されたユーザの情報を画面表示する |
※3: 組み合わせに制限のある引数
外部仕様により、以下の組み合わせは設定できません。
- リソース公開権限(-b)とユーザの種類が制限ユーザ(-z limited)
- グループ制約を受けない(-t)とユーザの種類が制限ユーザ(-z limited)または管理者(-z admin)
- 他ユーザの管理(-o)とユーザの種類がグループリーダ(-z groupleader)以外
- 作成可能ユーザ数(-u)とユーザの種類がグループリーダ(-z groupleader)以外
※4: アクセス制限用識別子(“user”、”group”など)は、指定されたフォルダを「アクセス禁止」にする目的で使用します。これら識別子と対応するフォルダとの関係は以下のとおり。
| アクセス制限用識別子 | 対象フォルダ名 |
|---|---|
| user | ユーザフォルダ(個人フォルダ) |
| group | グループフォルダ(共有フォルダ) |
| db | データベース |
| repos | リポジトリ(検索) |
| adm | 管理者 |
| adm-user | ユーザ |
| adm-group | グループ |
| adm-sql | SQL |
| adm-stat | 統計情報 |
| adm-dbms | DBMS |
| adm-update | クライアント更新 |
| adm-db-test | データベース(テスト用) |
| adm-msg | メッセージ |
| simple-user | (複合パラメータ: db、repos、admの3つ指定と同じ効果) |
| simple-user-non-private | (複合パラメータ: user, db, repos, adm の4つ指定と同じ効果) |
| simple-admin | (複合パラメータ: db, repos, adm-sql, adm-dbms, adm-db-testの5つ指定と同じ効果) |
※5:更新時のパラメータ指定方法
新規作成においては、設定が必要なパラメータは全て設定する必要があります。任意オプションの場合には、デフォルト値が適用されます。
更新においても、基本的には変更対象のパラメータは指定する必要がありますが、それ以外の更新の必要がないパラメータは「-s」をつけることで昔の値をそのまま使って更新できます。
※6:-2の注意事項
このパラメータをつけた場合は、-iで指定したユーザIDを-2で指定したユーザIDに変更するだけです。その他のパラメータは全て無視されます。
実行例
(例1)ユーザID「user1」、パスワード「pass1」、名称「ユーザ1」を作成する
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user1 -M add -p pass1 -n ユーザ1 ?a RW -b
アクセス権限はRW、公開権限あり、コメントなし、有効期限なし、ファイル数・サイズ制限なし、所属グループなし、制限フォルダなし、メールアドレスなし、一般ユーザのアカウントが1つ作成されます。
(例2)ユーザID「user2」、パスワード「pass2」、名称「xxxさま」、メールアドレス「xxx@yyy.com」、所属グループ「test」の読み取り専用の一般ユーザを作成
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user2 -M add -p pass2 -n “xxxさま” -m “xxx@yyy.com” -g test -a RO -z normal
(例3)ユーザID「user3」、パスワード「pass3」、名称「xxx印刷」、所属グループは「test」でユーザフォルダにアクセスさせない一般ユーザ(RW、公開できる)を作成
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user3 -M add -p pass3 -n “xxx印刷” -g test -a RW -b -z normal -l “user”
(例4)ユーザID「user1」のパスワードを「pass11」に変更する
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user1 -M update -p pass11 -s ?a RW
(例5)ユーザID「user1」を削除する
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user1 -M delete
(例6)ユーザ「user1」の情報を表示する
Name : ユーザ1
UserID : user1
PassWord : **********
MailAddress :
Resources : 0 / 0
Strorages : 0 / 0
User Type : General User
Status : Active
AccessAuthority : Read/Write Public
Maxcreationuser:
Valid until : Unlimited
Owner Name :
Owner ID :
AllowHosts : 192.168.0.1,172.16.0.0/16
Limited Zone :
Created : Fri Aug 11 04:20:45 2006
Lastmodified : Fri Aug 11 04:20:45 2006
Comment :
Available Group : test
(例7)ユーザ「user1」の情報をXMLで出力する (DTDは後述)
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TF:userinformation xmlns:TF="http://www.teamfile.com/DTD/TF/">
<TF:user>
<TF:userid>
<![CDATA[user1]]>
</TF:userid>
<TF:name>
<![CDATA[ユーザ1]]>
</TF:name>
<TF:password>
<![CDATA[pass1]]>
</TF:password>
<TF:mailaddr/>
<TF:usedstorage>0</TF:usedstorage>
<TF:maxstorage>0</TF:maxstorage>
<TF:usedresource>0</TF:usedresource>
<TF:maxresource>0</TF:maxresource>
<TF:usertype>
<TF:normal/>
</TF:usertype>
<TF:state>
<TF:active/>
</TF:state>
<TF:user-privilege>
<TF:readwrite/>
<TF:set-view/>
</TF:user-privilege>
<TF:expiration/>
<TF:creationdt>2006-08-10T19:20:45Z</TF:creationdt>
<TF:updatedt>2006-08-10T19:20:45Z</TF:updatedt>
<TF:comment/>
<TF:maxcreationuser/>
<TF:ownername/>
<TF:ownerid/>
<TF:allowhosts>192.168.0.1,172.16.0.0/16</TF:allowhosts>
<TF:availablegroup>
<TF:group>
<TF:groupid>00000393</TF:groupid>
<TF:name>
<![CDATA[test]]>
</TF:name>
</TF:group>
</TF:availablegroup>
</TF:user>
</TF:userinformation>
(例8)ユーザID「user1」のユーザIDを「user2」に変更する
#./pkusr -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i user1 -M update -2 user2
グループ管理コマンドライン(pkgrp)
グループコマンドラインの用途
- 新しいグループの作成 (ユーザを所属させることもできます)
- グループの編集
- グループの削除
pkgrpのパラメーター
グループの新規作成
| パラメータ | 説明 |
|---|---|
| -a | アクティブ [ active / inactive ] |
| -b | グループ制約 (カンマ区切り) [ write / showproperty / operationlog ] |
| -i | グループ名 |
| -c | グループにつけるコメント |
| -f | グループに初めから登録するフォルダ※1 |
| -l | グループオーナーを指定する(-l userid is groupleader) |
| -m | -iで指定したグループのオーナーを解任する |
| -w | メール監視(カンマ区切り) [ get / put / delete / copy / move ]+※3 |
| -u | このグループに所属させるユーザ(カンマ区切り) |
グループの更新
| パラメータ | 説明 |
|---|---|
| -a | アクティブ [ active / inactive ] |
| -b | グループ制約 (カンマ区切り) [ write / showproperty / operationlog ] |
| -i | グループ名(必須) |
| -c | グループにつけるコメント※2 |
| -l | グループオーナーを指定する(-l userid is groupleader) |
| -m | -iで指定したグループのオーナーを解任する |
| -n | 新しいグループ名 (グループ名を変更する際に指定、この場合は必須) |
| -w | メール監視(カンマ区切り) [ get / put / delete / copy / move ]+ ※2 |
| -u | このグループに所属させるユーザ(カンマ区切り)※2 |
| -s | 指定されていないパラメータはサーバの値を利用※2 |
グループの削除
| パラメータ | 説明 |
|---|---|
| -i | 削除対象のグループ名 |
| -q | 強制削除 |
グループ情報の表示
| パラメータ | 説明 |
|---|---|
| -i | 情報を表示するグループ名 |
| -d | グループ内部コード(数字) |
| -h | 所属ユーザ一覧(遅い) |
※1:フォルダ作成オプション
グループ作成と同時に任意のフォルダをグループフォルダの直下に作成することができます。作成するには「-f」オプションを利用して下さい。なお、「-f」を利用して作成されたグループは、指定されたフォルダを手動で削除するか-qオプションを付けた強制削除を行わない限り、グループそのものの削除が出来なくなります。ご注意ください。
※2:省略されたパラメータの扱いについて
基本的にpkusr と同じです。「-s」があれば昔の値を、無ければデフォルト値で更新します。
※3:メール監視状態の意味と動作は以下の通りです
| フラグ値 | 意味と動作 |
|---|---|
| get | ファイルの取得動作をメール監視する |
| put | ファイルのアップロード動作をメール監視する |
| delete | ファイル・フォルダの削除動作をメール監視する |
| copy | ファイル・フォルダのコピー動作をメール監視する |
| move | ファイル・フォルダの移動動作をメール監視する(名称変更は監視されません) |
pkgrpの実行例
(例1) グループ名「group01」、メール監視は「取得」と「登録」、ユーザ「user2」がいるグループを作成
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i group01 -M add -w "get,put" -u user2
(例2) グループ名を「group01」から「group001」に変更する
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i group01 -M update -n group001 -s
(例3) グループ名「group01」を削除する
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i group01 -M delete
(例4) グループ名「group01」の情報を表示する
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i group01 -M view
表示例:
GroupName : group01
GroupID : 00000400
Created : Fri Aug 11 04:56:13 2006
Lastmodified : Fri Aug 11 04:56:13 2006
Comment :
MailWatch : GET PUT
Available User : xxx印刷
(例5) グループ名「group01」の情報をXML出力する (DTDは後述)
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i group01 -M view –O xml
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TF:groupinformation xmlns:TF="http://www.teamfile.com/DTD/TF/">
<TF:group>
<TF:groupid>
<![CDATA[00000400]]>
</TF:groupid>
<TF:name>
<![CDATA[group01]]>
</TF:name>
<TF:creationdt>2006-08-10T19:56:13Z</TF:creationdt>
<TF:updatedt>2006-08-10T19:56:13Z</TF:updatedt>
<TF:comment/>
<TF:groupmailwatch>
<TF:triggermethod>GET PUT</TF:triggermethod>
</TF:groupmailwatch>
<TF:groupuri>
<![CDATA[/divy/Group Folder/group01/]]>
</TF:groupuri>
<TF:constraints>
<TF:operationlog/>
<TF:showproperty/>
</TF:constraints>
<TF:state>
<TF:active/>
</TF:state>
<TF:availableuser>
<TF:user>
<TF:userid>takehara</TF:userid>
<TF:name>
<![CDATA[xxx印刷]]>
</TF:name>
<TF:mailaddr>
<![CDATA[xxx@yyy.com]]>
</TF:mailaddr>
</TF:user>
</TF:availableuser>
</TF:group>
</TF:groupinformation>
(例6) 自分の所属グループ全部の所属ユーザを表示する
# ./pkgrp -U (管理者ID) -P (管理者パスワード) -H http://(ホスト名)/(ロケーション名)/ -i * -M view –h
出力例:
"経理部会計課","administrator(root)",”田中(tanaka)"
"営業部",”田中(tanaka)", ”上野(ueno)"
ファイルアップロードコマンドライン(pkput)
pkputの用途
- ファイルのアップロード
pkputのパラメーター
| パラメータ | 説明 |
|---|---|
| -d | アップロード対象となるファイルの更新日付を指定する( YYYY/mm/dd HH:MM:ss ) |
| -1 | -f で指定されたファイルだけをアップする(not recarsive call) |
| -t | target URI |
| -f | file or directory (ex: file1 file2 dir) このパラメータはpkputの最後の引数として指定して下さい |
-t はどこにアップロードを行うかを指定します。
例えば対象のホストが
http://aaa.bbb.com/aaaa/でアップロードしたいところが自分のユーザフォルダ(例:rootユーザ)の場合
-H http://aaa.bbb.com/aaaa/ -t root
になります。
-d を指定するとアップロード対象を更新日付で限定することができます。 例えば2014年1月1日の00時以降に更新されたファイルだけをアップロードしたい場合は、 -d “2014/01/01 00:00:00” 間に空白が入る為、ダブルクォートで囲ってください。
また、-fフラグにフォルダを指定した場合はその配下以下全てをアップロードします。
pkputの実行例
(例1) ローカルのファイルをアップロードする
./pkput –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ –t ターゲットURI -f フォルダパス
(例2) ローカルのファイルをグループAAAAにアップロードする
./pkput –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ –t “Group Folder/AAAA” -f フォルダパス
半角スペースを含む場合には、必ずダブルクォートを使って囲んでください。
出力結果
OK /CVS
OK /CVS/Root
OK /CVS/Repository
OK /CVS/Entries
OK- /projects
OK- /projects/CVS
SKIP /projects/abcd.txt
出力結果には四種類の表示結果があります。
| 表示結果 | 意味 |
|---|---|
| OK | アップロードに成功した |
| OK- | ハイフン付の場合は既にサーバにファイルがあり上書きを行った |
| FAIL | アップロードにエラーが発生した |
| SKIP | -d で指定された日付以前のファイルの為、処理をスキップした |
ファイルダウンロードコマンドライン(pkget)
pkgetの用途
- ファイルのダウンロード
pkgetのパラメーター
| パラメータ | 説明 |
|---|---|
| -m | リソースを移動する |
| -o | ダウンロード先のローカルパス (デフォルト:カレントディレクトリ) |
| -t | ターゲットURI |
| -1 | 階層を辿らない |
pkgetの実行例
(例1) 自分のユーザフォルダ(例:ユーザ名test)にあるファイルを全てローカルにダウンロードする
./pkget –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ –t “test” –O ./
(例2) ルート直下を全てダウンロード
./pkget –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ –t / –O ./
(例3) rootフォルダ直下のみをダウンロードして階層取得を行わない
./pkget –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ –t root/ –O ./ -1
-1で-tがファイルの場合はそのファイルのみ取得。フォルダの場合はそのフォルダの配下のみを取得します。
Warning
たとえこのコマンドであってもそのユーザが閲覧可能なフォルダしかダウンロードできません。ユーザが管理者(例えばrootユーザ)であった場合でも、他のユーザのプライベートなフォルダは閲覧できません。また、グループフォルダに関しても、所属していなければ取得できません。全てのユーザ、全てのグループをダウンロードする事はできません。
ファイル一覧表示コマンドライン(pklist)
pklistの用途
- ファイルの一覧表示
pklistのパラメーター
| パラメータ | 説明 |
|---|---|
| -a | ドットで始まるエントリを表示する |
| -l | 詳細フォーマットで表示する |
| -t | ターゲットURI |
| -1 | 1行に1ファイルずつ表示する |
pklistの実行例
(例1) TeamFileにログインした(トップロケーション)の一覧を取得する
./pklist –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/
(例2) 詳細に表示する(Unixのlsに似た表示になります。
./pklist –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ -l
(例3) URLだけを表示する( ls –1 に似た表示になります)
./pklist –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ -1
ファイル削除コマンドライン(pkdel)
pkdelの用途
- ファイルの削除
pkdelのパラメーター
| パラメータ | 説明 |
|---|---|
| -g | 削除を実行する |
| -r | 再帰的に検索する |
| -t | ターゲットURI |
| -x | 正規表現を使用する(文字列) |
- -g は、このフラグをつけないと本来の削除は行われません。(一覧表示だけを行います)
- -r は、再帰的に取得して対象のファイルを削除します。
- -x は、正規表現を行う文字列を指定します。
- -xは、正規表現を利用することを表しています。例えばroot配下のtxtだけを削除したい場合はroot/.*.txt$のように入力します。具体的な例を実行例(10.3 )で説明します。
pkdelの実行例
(例1) ファイルを一つ削除する
./pkdel –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ -t root/aaa.txt
(例2) フォルダを削除する(配下全て削除されます)
./pkdel –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ -t root/foler/
(例3) root配下にある、PDFファイルだけを削除する
./pkdel –U (管理者D) –P (管理者パスワード)-H http://(ホスト名)/(ロケーション名)/ -t root –x “.*\.pdf$” -r
Info
正規表現は、PCREを利用しています。Perlの正規表現と同じ動作となります。サンプルも様々なWebサイトで紹介されていますのでご参照ください。
Info
削除は、データを消去してしまうツールの為、-gオプションがなければ本来の実行は行われません。単に一覧を表示して終了します。よくご確認のうえご利用ください。
エラーコード一覧
コマンドラインを実行した結果、何らかのエラーが発生した場合にはその結果をコマンドラインの戻り値として呼び出したプログラムに返却します。下記に記述いたしますエラーコードが得られた場合にはそれに応じたリカバリー処理をお願い致します。
| エラーコード | エラー内容・リカバリー方法 |
|---|---|
| 0 | 正常終了 |
| 1 | 正常終了だが0の正常とは異なる(コマンドごとに異なります) |
| 10 | エンコードエラーが発生したことを示します。 入力された文字のエンコードが正しいかどうかご確認ください |
| 11 | 引数または環境変数のホスト名が省略されました |
| 12 | URIに含まれるポート番号パートが不正です |
| 13 | -U パラメータで管理者ユーザのユーザIDが指定されていない |
| 14 | -P パラメータで管理者ユーザのパスワードが指定されていないか、ユーザ更新時に-p で更新ユーザのパスワードが指定されていない。-p を省略するには「-s」が必要です |
| 15 | -i パラメータで処理対象のユーザIDが指定されていない (pkusr) |
| 16 | -n パラメータがユーザの更新処理で省略された。省略するには「-s」が必要 |
| 17 | -z パラメータに指定されたユーザの種類が正しくなかった。admin、normal、limited、groupleaderの何れかを指定して下さい (pkusr) |
| 18 | パラメータ内容に矛盾があります。同時に指定できないパラメータが指定されました。 -z (ユーザの種類)と-k (管理者権限)が同時に使用された。-z のみをお使いください (pkusr) |
| 19 | 制限ユーザに対し公開権限を付けようとした。ユーザの種類を変えていただくか、-b を除去して公開権限を与えないようにして下さい(pkusr) |
| 20 | 入力されたパラメータが不正。 必須パラメータが省略されていないかどうかご確認ください |
| 21 | ユーザ情報の表示を行う時、-Uまたは-Pに指定された管理者のユーザIDまたはパスワードに誤りがあった(pkusr) |
| 22 | プロキシ認証に失敗しました。プロキシ関連パラメーターを確認してください。 |
| 23 | 正規表現の構文エラーです。(pkdel) |
| 50 | ホストが見つかりません |
| 51 | ユーザ情報の表示において、-i で指定されたユーザが存在しなかった(pkusr) |
| 52 | ユーザ情報の表示で-v(チェックモード) が指定された時、-i で指定されたユーザが既に期限切れになっていたことを示す。ユーザ状態のチェック用のステータスコードです(pkusr) |
| 53 | ユーザ情報の表示で-v(チェックモード) が指定された時、-i で指定されたユーザが非アクティブになっていたことを示す。ユーザ状態のチェック用のステータスコードです (pkusr) |
| 54 | ユーザが既に存在していました。(pkusr) |
| 55 | ユーザを削除できなかったためユーザを非アクティブにした(pkusr) 実際にユーザは削除されていません。 |
| 60 | ファイルが存在しません |
| 61 | アクセスが拒否されました。 |
| 70 | 指定されたグループ名のグループが存在しなかった。(pkgrp) -i パラメータに指定したグループ名をご確認ください。 |
| 71 | グループの削除に失敗した(pkgrp) 多くの場合、対象グループフォルダの中にファイルやフォルダが残ったままになっている、ロックが残ったままになっているためです。手動で削除してから再試行して下さい。 |
| 72 | 対象のグループに既にグループのオーナーが存在しました。一つのグループには一人のオーナーしか指定できません。既に登録されているオーナーを解任してから再度指定してください。(pkgrp) |
| 73 | ユーザの所属解除に失敗しました。これはグループリーダーがそのグループのオーナーになっている場合があります。オーナー解除を行ってから再試行してください(pkgrp) |
| 74 | グループが既に存在していました。(pkgrp) |
| 80 | -f で指定された初期フォルダの作成に失敗しました (pkgrp) |
| 81 | (このエラーコードは廃止されました) グループまたはユーザの削除に失敗した。多くの場合、対象グループまたはユーザフォルダの中にファイルやフォルダが残ったままになっているためです。手動で削除してから再試行して下さい。 |
| 82 | 親フォルダが存在していませんでした。 |
| 83 | ダウンロードフォルダが存在しません(pkget) |
| 99 | 予期しない理由によりコマンドの実行に失敗しました |
| 999 | (このエラーコードは廃止されました) コマンドラインツールの有効期限が切れました |