FCPutilの利用

FCPutilは、動作のステータスを返すことができます。そのため、返されたステータスを処理するスクリプトを作成できます。
FCPutilは、NETコマンドのSTOP、PAUSE、CONTINUEよりはるかに多くの機能をサポートしています。
FCPutilはプラットフォームに依存しないネットワークベースのユーティリティであるため、サーバをホストするマシン以外のマシンや異なるプラットフォームのマシンから実行できます。

FCPUtilとFCUtilの違い

FCUtilは、非常に単純なWindowsユーティリティとして作られたものです。FCPutilは、それまで使われていたこのツールを発展させたもので、後継製品として新しい機能が追加されています。FCPutilにはFCUtilとほとんど同じ機能が搭載されていますが、以下のような大きな違いがあります。

FCUtilはFirstClassサーバと同じマシンで実行する必要がありますが、FCPutilはネットワーク経由で実行できます。
FCUtilではWindowsプラットフォームが必要ですが、FCPutilではプラットフォームが同じである必要はありません。

例えば、Windows版のFCPutilを使用してWindowsサーバやOS Xサーバを管理できます（その逆も可能です）。

FCPutilでは、FCUtilにはないGETSTATSコマンドを使用できます。

GETSTATSは、サーバによって管理されているリアルタイムカウンタの現在値を取得します（アクティブなセッションの数、タスクの負荷、開かれているファイルの数など）。サーバモニタで取得できる統計値の多くが、このコマンドを使用してリモートで取得できます。

FCPutilでは、FCUtilのインターネットサービス固有の機能はサポートされません。
実際のクライアントログセッションを使用するFCPutilでは接続情報とアカウント情報が必要になるため、標準の設定ファイル（fcputil.fc）が必要です。
FCUtilはサブシステムのエラーリターンコードを直接返しますが、FCPutilは高レベル（クライアント）のエラーコードを返します。例えば、ミラーが一時停止されてないときにCONTINUEコマンドを実行すると、FCUtilはエラー4117を返しますが、FCPutilはエラー1030を返します。どちらも「アクセス拒否」エラーです。

先頭へ

FCPUtilの設定

FCPutilはFirstClassサーバによって自動的にインストールされるため、必要となる作業は設定だけです。設定は以下の手順で実行できます。

手順1：ユーザアカウントの作成

手順2：設定ファイルの作成

手順3：アカウントのカスタマイズ

手順1：ユーザアカウントの作成

注意

新しいアカウントの設定は必須ではありませんが、設定しない場合は管理者アカウントを使用することになるため、アカウントを設定することをお勧めします。新しいカウントを設定しないことにした場合は、使用するアカウントに［サーバの監視］権限と［サーバの管理］権限が付与されていることを確認してください。

1 アタrしいユーザを作成し、その新しいアカウントに強固なパスワードを設定します。

2 このアカウントに［サーバの監視］権限と［サーバの管理］権限を追加します。

3 このアカウントが、パスワードの保存が可能なグループに所属していることを確認します。

注意

このアカウントを副管理者アカウントにする必要はありません。

手順2：設定ファイルの作成

1 FirstClassの実行ファイルが格納されているフォルダに移動します。

2 Inetsvcs.fcなどの設定ファイルのコピーを作成し、名前をfcputil.fcに変更します。

手順3：アカウントのカスタマイズ

1 FirstClassクライアントを起動します。

2 ［参照］をクリックします。

3 FirstClassがインストールされているフォルダを参照し、fcputil.fc設定ファイルを開きます。

注意

fcputil.fcファイルは、FirstClassの実行ファイルと同じ場所に保存されています。

4 このアカウントのユーザIDとパスワードを入力して、［保存］をクリックします。

5 FirstClassクライアントでログインを実行し、この設定ファイルを使用してクライアントがサーバに接続できることを確認します。

よくあるエラー

FCPutilの設定でよくあるエラーは以下の2つです。

1003	ユーザ名またはパスワードが間違っています。また、適切な権限（［サーバの監視］と［サーバの管理］）がアカウントに付与されていません。
4105	fcputil.fcがFCPutilと同じ場所にあるか、アカウントが正しく設定されていません。上記の手順を確認してください。

先頭へ

構文

FCPUTILのコマンド行構文は、前述のFCUtilとほぼ同じです。FCPutilを実行し、処理するコマンドとそのコマンド用の追加の引数を指定します。

構文：fcputil <コマンド> [パラメータ] [SERVER || FCS || IS || FCINTSRV || VS || VSERVICE]

または、fcputil [-s|-S] getstats [id [id ...] ]

または、fcputil -h（基本的な構文に関するヘルプとよく使用されるコマンドを表示）

または、fcputil -H（構文とよく使用されるキーワードの完全なリストを表示）

スイッチ	パラメータ	内容
-h		よく使用する操作の一般的なヘルプを表示します
-H		使用可能なすべてのコマンドの完全なリストを表示します
-v		FCPutilのバージョンを表示します
-s		詳しくは、GETSTATSを参照してください
-S		詳しくは、GETSTATSを参照してください

コマンド	パラメータ	内容
よく使用される主要なコマンド
ABOUT		サーバのバージョンを（サーバコンソールのログファイルに）表示します
WAIT	n	指定した時間だけFCPutilを一時停止します（nは秒数）注意このコマンドはローカル専用です。つまり、サーバ側との通信は行われないため、このコマンドを使用するために設定ファイルを使用する必要はありません。
BROADCAST	"<メッセージ>"	ログイン中のユーザ全員に同報メッセージを送信します
DISABLE		すべてのログインを無効にします（管理者ユーザ、副管理者ユーザ、およびメンテナスユーザは除く）
ENABLE		すべてのユーザおよびサービスによるログインを有効にします
LOGOFF	<ユーザID>	特定のユーザを強制的にログオフします
AUDIT		コアサーバの監査を開始します
TC		上記のAUDITコマンドのエイリアスです
TRASH		上記のAUDITコマンドのエイリアスです
STOPAUDIT		（現在のフォルダの監査が完了した後に）監査を強制的に停止します
FAST		高速シャットダウン（通常のシャットダウン）を実行します
POLITE		標準シャットダウンを実行します
QUIT		サーバを停止/終了します（サーバの場合、このコマンドはFASTと同じです）
バックアップ、ミラーリング、スナップショットのための一時停止
HOLD	n	指定した時間だけサーバをスナップショットのために一時停止します（nは秒数）
PAUSE		CONTINUEコマンドが実行されるまでミラーリングを一時停止します（成功すると0が、失敗するとFirstClassのエラーコードが返されます）
CONTINUE		PAUSEによって一時停止されたミラーリングを再開します（成功すると0が、失敗するとFirstClassのエラーコードが返されます）
CONT		上記のCONTINUEのエイリアスです
RESYNC		すべてのミラーに対して完全なミラー同期を強制的に実行します（成功すると0が、失敗するとFirstClassのエラーコードが返されます）
MCHECK		エラーレベルに対応した以下のリターンコードでミラーの現在のステータスを返します 0：すべてのミラーリングが一時停止されています 1：ミラーリングされているボリュームはありません 2：すべてのミラーが同期され、アクティブになっています 3：少なくとも1つのミラーリングされたボリュームでまだ同期が行われています 4：ミラーリングされたボリュームによってミラーリングのステータスが異なっています 5：少なくとも1つのミラーリングが失敗しました
MDUMP		ミラーリングの現在のステータスを返し（MCHECKを参照）、コンソールおよびログファイルにテキストとして出力します
MIRRORLOG		コンソールおよびログファイルへのミラーリング関連のデバッグメッセージの表示を有効または無効にします
QSHOW		待機中のミラーリングの詳細リストを表示します警告出力される情報量が非常に多くなる場合があります
QSUMMARY		待機中のミラーリングの要約リストを表示します
パフォーマンスと統計値
GETSTATS		詳しくは、GETSTATSを参照してください
PSTATS		パフォーマンス関連の統計値の概要をコンソールおよびログファイルに出力します
PRESET		PSTATSコマンドで報告されたパフォーマンス統計値をリセットします
MEM		メモリ使用の概要をサーバコンソールおよびログファイルに表示します
その他の主要なコマンド
GATEWAY	<ゲートウェイ名>	ゲートウェイを強制的に接続します（エイリアスはREPLICATEとNOW）
REPLICATE	<ゲートウェイ名>	GATEWAYコマンドまたはNOWコマンドのエイリアスで、指定したゲートウェイを強制的に接続します
NOW	<ゲートウェイ名>	GATEWAYコマンドまたはREPLICATEコマンドのエイリアスで、指定したゲートウェイを強制的に接続します
HIGH		内部サーバの優先度を［高］に設定します
MEDIUM		内部サーバの優先度を［中］に設定します
MED		上記のMEDIUMコマンドのエイリアスです
LOW		内部サーバの優先度を［低］に設定します
その他の現在のステータスに関するコマンド
GATEWAYS		ゲートウェイのリストをコンソールおよびログファイルに出力します
GROUPS		グループのリストをコンソールおよびログファイルに出力します
LISTFILES		開かれているすべてのファイルのリストをコンソールおよびログファイルに出力します警告大規模なサイトでは数万のファイルが開かれていることがありますので、十分ご注意ください
LISTOBJS		開かれているすべてのオブジェクトのリストをコンソールおよびログファイルに出力します警告大規模なサイトでは多数のオブジェクトが開かれていることがありますので、十分ご注意ください
NOTIFY		通知テーブルをコンソールおよびログファイルに出力します
SESSION		セッションのステータスをコンソールおよびログファイルに出力します
SESSIONS		上記のSESSIONコマンドのエイリアスです
STATS		サーバの統計値の概要を表示します
STATUS		セッションの他の（異なる）ステータスの概要を表示します
TASKS		サーバタスクのリストをコンソールおよびログファイルに出力します
よく使用されるログ取得オプション
CONSOLE		［Console to File］オプションを有効または無効にします（最新のサーバでは、fcs.logファイルのログ取得を有効または無効にします）
CONSOLELOG		コンソールのログ取得を強制的に有効にします（有効と無効を切り替えることはできません）
NOCONSOLELOG		コンソールのログ取得を強制的に無効にします（有効と無効を切り替えることはできません）
LOGINLOG		コンソールおよびログファイルへのすべてのログインおよびログオフの記録を有効または無効にします
MAILLOG		メッセージ（MTA）配信のログ取得を有効または無効にします
MAIL		上記のMAILLOGコマンドのエイリアスです
その他のログ取得およびデバッグオプション
BATCHADMIN		FirstClassスクリプト（バッチ管理）の動作のサーバログを有効にします
REMADMIN		上記のBATCHADMINコマンドのエイリアスです
DB		データベース拡張のログを有効または無効にします
DBGALL		すべてのサーバデバッグログを有効にします
DEBUG		上記のDBGALLコマンドのエイリアスです
DBGCORE		コアサーバ動作のサーバデバッグログを有効にします
DBGDIR		ユーザディレクトリ動作のサーバデバッグログを有効にします
DBGFILE		ファイル入出力動作のサーバデバッグログを有効にします（おもにコアバッファリングメッセージ）
DBGIS		サービス（インターネットサービスなど）のサーバデバッグログを有効にします
DBGTC		監査動作のサーバデバッグログを有効にします
DBGNONE		すべてのサーバデバッグログを無効にします
DBGSESS		セッション関連動作のサーバデバッグログを有効にします
GWCDATA		ゲートウェイクライアントプロトコルのデバッグ（データ出力）の表示を有効または無効にします
GWCDEBUG		ゲートウェイクライアントプロトコルの完全な（詳細な）表示を有効にします
GWCNONE		ゲートウェイクライアントプロトコルのデバッグメッセージの表示を無効にします
GWCOPEN		ゲートウェイクライアントプロトコルのデバッグ（開く動作と閉じる動作）を有効にします
GWCWARN		ゲートウェイクライアントプロトコルのデバッグ（警告メッセージ）を有効にします
GWMAIL		ゲートウェイクライアントプロトコルのデバッグ（メール関連動作）を有効にします
PACKET		すべてのパケットデバッグログ（パケットデータの内容を含む）を有効にします
PKTCONN		コンソールおよびログファイルへの接続関連のパケットデバッグメッセージの表示を有効にします
PKTERR		コンソールおよびログファイルへのパケットエラーデバッグメッセージの表示を有効にします
PKTMDM		コンソールおよびログファイルへのモデル（セッション）関連のパケットデバッグメッセージの表示を有効にします
PKTMOST		コンソールおよびログファイルへのすべてのパケットデバッグメッセージの表示を有効にします（送信済みパケットと受信済みパケットのデータは除く）
PKTNONE		すべてのパケットデバッグメッセージを無効にします
PKTSTAT		パケット関連の各統計値をコンソールおよびログファイルに出力します
PKTRX		コンソールおよびログファイルへの受信済みパケットデバッグメッセージの出力を有効にします
PKTTX		コンソールおよびログファイルへの送信済みパケットデバッグメッセージの出力を有効にします
RESET		（サーバでサポートされなくなった）モデムおよびネットワークのディスパッチャをリセットします

例

このスクリプトは、複数のFCPutilコマンドで構成されています。もうすぐシャットダウンが行われることをユーザに警告してから、高速シャットダウンを実行します。

FCPUTIL BROADCAST "サーバが5分後にシャットダウンされます。"

FCPUTIL WAIT 240

FCPUTIL BROADCAST "サーバが1分後にシャットダウンされます。ログオフしてください。"

FCPUTIL WAIT 60

FCPUTIL BROADCAST "サーバが今すぐシャットダウンされます。"

FCPUTIL WAIT 5

FCPUTIL FAST

以下は、2つのMDUMPコマンドの実行によってコンソールログファイルに出力された内容です。一方のコマンドはミラーがまだ同期されている間に実行され、もう一方のコマンドは同期が完了した後に実行されました。

[2010/03/01 01:32:04] Volume 8001 ("G:")mirror state is FULL SYNC (90%).

[2010/03/01 01:32:04] Volume 853C ("E:")mirror is ACTIVE.

[2010/03/01 01:32:54] Mirror:Beginning incremental sync of 13 item(s) ...

[2010/03/01 01:33:01] Mirror:Incremental sync of 13 item(s) complete.

[2010/03/01 01:33:01] Mirror:Volume 8001 sync complete.Mirror active.

[2010/03/01 01:34:57] Volume 8001 ("G:")mirror is ACTIVE.

[2010/03/01 01:34:57] Volume 853C ("E:")mirror is ACTIVE.

先頭へ

GETSTATSコマンド

このコマンドを使用すると、目的の機能に対応したサーバの統計値を要求することによって、リアルタイムの統計値をサーバからリモートで取得できます。

構文

GETSTATSコマンドの構文は以下の通りです。

FCPUTIL [ -s | -S ] GETSTATS [ <統計ID> ... ]

統計ID

以下は、すべての統計IDとその値のリストです。よく使用される統計値は、青色で区別しています。

統計値の名前	統計ID番号	説明

サブシステムの統計値
一般的な統計値
StatCounter	0	1から始まり、統計値が返されるたびに増加します
Sanity	1	常に値1を返します
Version	2	常に現在のサーバのバージョンを返します（例：8.000）
Build	3	常に現在のサーバのビルド番号を返します（例：200.0）

タスクの統計値（増分）
LastReset	1000	以前に統計値をリセットしてからの時間（ミリ秒）
Loops	1101	タスク一覧の繰り返し表示
Tasks	1102	スケジュール設定されたタスクの合計数
IO	1103	要求された入出力動作
AsyncIO	1104	同期されなかった入出力動作（IOList）
Idle	1105	Idlerがスケジュール設定された回数
WakeIdle	1106	アイドル動作のためにタスクがスリープ状態から復帰した回数
Suspend	1107	タスクがレディリストから削除された回数
HotTasks	1108	タスクがホットリストからスケジュール設定された回数
Longest	1109	インターバルのためのタスクループでの最長待ち時間

タスクの統計値（累積）
TLoops	1201	タスク一覧の繰り返し表示
TTasks	1202	スケジュール設定されたタスクの合計数
TIO	1203	要求された入出力動作
TAsyncIO	1204	同期されなかった入出力動作（IOList）
TIdle	1205	Idlerがスケジュール設定された回数
TWakeIdle	1206	アイドル動作のためにタスクがスリープ状態から復帰した回数
TSuspend	1207	タスクがレディリストから削除された回数
THotTasks	1208	タスクがホット入出力リストからスケジュール設定された回数
TLongest	1209	期間内のタスクループでの最長待ち時間
TAverage	1210	期間内のタスクループでの平均待ち時間

ファイルの統計値（増分）
Opens	1301	ファイルオープン「要求」の合計数
Reads	1302	要求された読み取り動作
ReadHits	1303	SAFileキャッシュから実行された読み取り動作
ReadSysHits	1304	ファイルシステムキャッシュから実行された読み取り動作
ReadBytes	1305	読み取り動作中に転送されたバイト数
Writes	1306	要求された書き込み動作
WriteHits	1307	SAFileキャッシュから実行された書き込み動作
WriteSysHits	1308	ファイルシステムキャッシュから実行された書き込み動作
WriteBytes	1309	書き込み動作中に転送されたバイト数

ファイルの統計値（累積）
TOpens	1401	ファイルオープン「要求」の合計数
TReads	1402	要求された読み取り動作
TReadHits	1403	SAFileキャッシュから実行された読み取り動作
TReadSysHits	1404	ファイルシステムキャッシュから実行された読み取り動作
TReadBytes	1405	読み取り動作中に転送されたバイト数
TWrites	1406	要求された書き込み動作
TWriteHits	1407	SAFileキャッシュから実行された書き込み動作
TWriteSysHits	1408	ファイルシステムキャッシュから実行された書き込み動作
TWriteBytes	1409	書き込み動作中に転送されたバイト数

その他のファイル統計値
Open	1400	現在開かれているファイルの合計数

FirstClassサーバの統計値
時間のパフォーマンス統計値
MS	2001	この期間のミリ秒
TPL	2002	ループごとの時間通知
LPS	2003	1秒あたりのループ数
TPS	2004	1秒間あたりのタスクスイッチ
Usage	2005	タスク読み込みインジケータ（割合）

その他の2つの概要読み込みバー
DiskAvg	2011	平均ディスク応答時間（サーバのオーバヘッドを含む）
DiskLoad	2012	上記と同じ（ただし、任意の読み込み（割合）バーに変換）
ServerAvg	2021	平均サーバ応答時間
ServerLoad	2022	上記と同じ（ただし、任意の読み込み（割合）バーに変換）

ディスクの動作（システム要求）
DiskOps	2030	ディスク動作の合計数（増分）
DiskOpsMTA	2031	緊急性の高いタスク（MTAなど）によるディスク動作の合計数（増分）

サーバのスナップショットの統計値
Modems	2101	モデム接続の現在の数
Connected	2102	ネットワーク接続の現在の数（リモートを含む）
Priority	2103	0=prDedicated（高）、1=prSharedApp（中）、2=prBackground（低）
SessionLED	2104	0=通常、1=警告、2=使用率が100％以上の状態
Logins	2105	ログイン合計数
Remote	2106	現在使用しているリモートセッションライセンスの数（FirstClass 8・0ビルド242以降のサーバが必要）

その他のサーバ統計値
SessionLimit	2110	セッションごとのメモリ制限
AuditProgress	2111	完了または100（実行されていない場合）

サーバモニタの時刻
LastFileReset	2201	［ファイル］タブの最後の「リセット」時刻またはサーバ起動時刻
LastTaskReset	2202	［タスク］タブの最後の「リセット」時刻またはサーバ起動時刻
ServerBoot	2203	サーバ起動時刻

メッセージキューの統計値
Deliveries	2301	配信されたメッセージ
Active	2302	配信待機中のメッセージ
Urgent	2303	待機中の重要度［高］のメッセージ
UrgentQ	2304	キューが占める割合
Normal	2305	待機中の重要度［標準］のメッセージ
NormalQ	2306	キューが占める割合
Bulk	2307	待機中の重要度［低］のメッセージ
BulkQ	2308	キューが占める割合
Junk	2309	待機中の重要度［ジャンク］のメッセージ
JunkQ	2310	キューが占める割合
Held	2311	待機中の保留メッセージ
HeldQ	2312	キューが占める割合
Delayed	2313	待機中の遅延メッセージ
DelayedQ	2314	キューが占める割合

システムの統計値
メモリの統計値
MemAppTotal	9001	サーバに利用できる合計システムメモリ（アドレス空間などの制限要因を除く）
MemAppAvail	9002	サーバに利用できるシステムメモリ（アドレス空間などの制限要因を除く）
MemVirtTotal	9003	サーバマシンの合計仮想メモリ
MemVirtAvail	9004	サーバマシン上でサーバに利用できる仮想メモリ
MemAddrTotal	9005	サーバ処理用の合計アドレス空間
MemAddrAvail	9006	サーバ用に現在利用できるアドレス空間
MemPhysTotal	9007	サーバマシンの合計物理メモリ
MemPhysAvail	9008	サーバマシンで利用できる物理メモリ

例

以下のコマンドは、通常は［サーバモニタ］の［サマリ］タブに表示される3種類のサーバ負荷の割合を返します。

FCPUTIL GETSTATS 2005 2012 2022

出力は以下のようになります。

C:\>FCPUTIL GETSTATS 2005 2012 2022

FCPUtil Version 8.0.5 [Nov 22 2004]

Stat ID Current Statistic Value

======= =======================

2005 0.000

2012 0.220

2022 0.000

3 statistics returned.

注意

統計IDを指定しない場合、FCPutilはデフォルトのリストである「2 3 2005 2012 2022 1400 2111 2301 2302 9002」を使用します。

処理がより自動的に行われるようにする場合は、出力結果が複雑で冗長になるのを避けるために2つのオプション（-sおよび-S）を使用できます。

-sは、以下のように「ID=値」の形式のリストを返します。

C:\>FCPUTIL -s GETSTATS 2005 2012 2022

2005=0.000 2012=0.235 2022=0.000

-Sは、以下のように値のリストのみを返します。

C:\>FCPUTIL -S GETSTATS 2005 2012 2022

0.000 0.358 0.000

サーバのパフォーマンスを追跡する場合は、通常、以下のような簡略化された形式がデフォルトの統計値リストになります。

C:\>FCPUTIL -S GETSTATS

8.000 203.000 0.000 0.231 0.000 44.000 100.000 0.000 0.000 1072410624.000

先頭へ