n-Archives.net

nWOLc マニュアル:nWOLのコンソールコマンド

目次


nWOLcの概要

nWOLc.exe は、nWOLに登録されているホストに対して、マジックパケット送信、ホスト状態確認処理、起動完了待機処理を、コマンドラインから行うためのコマンドです。このコマンドを利用すると、バッチファイルやタスクスケジューラなどから処理を起動させることができるようになります。

nWOLのパッケージに同梱されており、インストーラを使ってインストールすると、nWOLと同じフォルダ(C:\Program Files\nWOL)に置かれます。

 

nWOLc.exe で実行できるオプションは以下の通りです。

nWOLc: nWOL console command   (Version 1.5.31)

-l ["regex"]           List all or regex-matched hosts
-a                     Send magic packet to all WOL capable hosts
-h hostnames...        Send magic packet to specified WOL capable hosts
-r "regex"             Send magic packet to regex-matched WOL capable hosts
-m mac [ip [mask]]     Send magic packet
-p hostname            Check status of a host(or IP) (retcode=0 when online)
-w hostname [waitsec]  Wait for a host(or IP) to come online (retcode=0 when online)
-t sec                 Set ping timeout in seconds for -p or -w (default=1)
-i                     Ignore case when -l or -r
-c filename            Configuration file name(Absolute path/User name)
-o filename            Redirect console output to a file(Absolute path)
-v                     Verbose mode
-n                     No output messages
-?                     Help

 

オプション解説

-l ["regex"] :ホスト名一覧の表示

nWOLに登録されているホスト名の一覧を表示します。

コマンド例 説明
nwolc -l
nWOLに登録されている全てのホスト名を表示する。
nwolc -l ^a.*z$
nWOLに登録されているホストのうち、正規表現(記載例は aで始まりzで終わる)にマッチするものを表示する。
nwolc -l server -i
nWOLに登録されているホストのうち、正規表現(serverという文字列を含む)にマッチするものを表示する。大文字小文字を区別しない。
  • 正規表現に空白を含む場合などは、” ” で囲んでください。
  • nWOLで使用する正規表現の詳細については、以下のマイクロソフトのページを参照してください。
    Regular Expression Language - Quick Reference」(マイクロソフトのページ)

 

-a :全てのホストにマジックパケットを送信する

nWOLに登録されているホストのうち、WOLが許可されている全てのホストに対してマジックパケットを送信します。

コマンド例 説明
nwolc -a
WOLが許可されている全てのホストにマジックパケットを送信する。

-h hostnames... :ホスト名を指定してマジックパケットを送信する

ホスト名を指定してマジックパケットを送信します。WOLが許可されていないホストは除外されます。

コマンド例 説明
nwolc -h Server1 "File Server"
Server1, File Server にマジックパケットを送信する。
  • ホスト名に空白を含むような場合は、" " で囲んでください。
  • ホスト名は空白で区切って複数指定できます。
  • 大文字小文字を区別します。

 

-r "regex" :正規表現にマッチする全てのホストにマジックパケットを送信する

正規表現にマッチするホスト全てにマジックパケットを送信します。WOLが許可されていないホストは除外されます。

コマンド例 説明
nwolc -r ^[0-9]
ホスト名が数字で始まるホスト全てにマジックパケットを送信する。
nwolc -r PC$ -i
"PC" という文字列で終わる全てのホストにマジックパケットを送信する。大文字小文字は区別しない。
  • 正規表現に空白を含む場合などは、” ” で囲んでください。
  • nWOLで使用する正規表現の詳細については、以下のマイクロソフトのページを参照してください。
    Regular Expression Language - Quick Reference」(マイクロソフトのページ)

 

-m mac [ip [mask]] :マジックパケットを送信する

MACアドレスを直接指定してマジックパケットを送信します。

コマンド例 説明
nwolc -m abcdef123456
同一LAN内に存在し、MACアドレスが abcdef123456 であるホストにマジックパケットを送信する。
nwolc -m abcdef123456 192.168.1.20
同一LAN内に存在し、MACアドレスが abcdef123456、IPアドレスが192.168.1.20 であるホストにマジックパケットを送信する。
nwolc -m abcdef123456 192.168.10.20 255.255.255.0
nwolc -m abcdef123456 192.168.10.20 24
nwolc -m abcdef123456 192.168.10.20/24
ルータを経由した先に存在し、MACアドレスが abcdef123456、IPアドレスが192.168.10.20、ネットマスクが 255.255.255.0 (24bit) であるホストにマジックパケットを送信する。
nwolc -m abcdef123456 192.168.10.255
ルータを経由した先に存在し、MACアドレスが abcdef123456、ディレクティッドブロードキャストアドレスが192.168.10.255 であるホストにマジックパケットを送信する。
  • 同一LAN内のホストに対しては、MACアドレスのみ指定すれば送信できます。
  • MACアドレスのみ指定した場合、接続されている全てのネットワークIFからマジックパケットが送信されます。複数のネットワークIFが接続されているが、送信先ホストが存在するネットワークIFからのみパケットを送信したい場合は、IPアドレスを指定してください。(ネットマスクは指定する必要はありません。)
  • ルータを経由した先のホストにマジックパケットを送信する場合は、送信先ホストのIPアドレスとネットマスクを指定するか、送信先ホストの存在するNWのディレクティッドブロードキャストアドレスを指定する必要があります。
  • ディレクテッドブロードキャストアドレスとは、IPアドレスのホスト部の全てのビットを1にしたアドレスです。
    参考記事:「ブロードキャストアドレスの種類を知る 」 (atmarkIT記事)

 

-p hostname :ホストの起動状態を調べる

指定されたホストに ping を送信して、ホストの起動状態を調べます。

コマンド例 説明
nwolc -p Server1
Server1 の起動状態を調べる。
nwolc -p 192.168.1.6
192.168.1.6 の起動状態を調べる。
nwolc -p Server1 -t 3
Server1 の起動状態を調べる。pingのタイムアウトを3秒に設定する。
  • 起動状態であった場合は戻り値 0、それ以外の場合は戻り値 1 となります。
  • ping のタイムアウトはデフォルトで1秒となっています。

※参考:ホストの起動状態はpingコマンドでも確認できますが、Windowsのpingコマンドの場合、「宛先に到達できない(送信先アドレスへのルートがない)場合」についても、戻り値が 0(正常) となります。nwolc -p の場合、正常に応答が返ってきた場合以外は全て戻り値が 1 となります。

 

-w hostname [waitsec] :ホストが起動状態になるまで待機する

指定されたホストにpingを継続的に送信し、正常な応答があるまで繰り返します。指定されたホストが起動状態になるのを待機します。待機時間は最大waitsec秒となります。waitsecを指定しない場合、ホストが起動するまでコマンドが終了しませんのでご注意ください。

コマンド例 説明
nwolc -w Server1 60
Server1 が起動するまで最大60秒間待機する。
nwolc -w Server1
Server1 が起動するまで永遠に待機する。タイムアウトしない。
nwolc -w 192.168.1.6 60
192.168.1.6 が起動するまで最大60秒間待機する。
nwolc -w 192.168.1.6 60 -t 3
192.168.1.6 が起動するまで最大60秒間待機する。pingのタイムアウトを3秒に設定する。
nwolc -h Server1 -w Server1 60
Server1にマジックパケットを送信した後、Server1が起動するまで最大60秒間待機する。
nwolc -a -w Server1 60
全てのホストにマジックパケットを送信した後、Server1が起動するまで最大60秒間待機する。
  • -w は、-a, -h, -r と同時に指定することができます。その場合、マジックパケットを送信した後、指定されたホストが起動するまで待機します。
  • 起動状態になった場合、戻り値は 0 となります。待機時間が過ぎた場合など、それ以外の場合は 1 となります。
  • -a, -h, -r と同時に使用した場合、-a, -h, -r の実行状況にかかわらず、-w の実行結果が戻り値として返されます。

 

-t sec :pingのタイムアウト秒数を設定する

-p, -w で実行される ping のタイムアウト秒数を設定します。

コマンド例 説明
nwolc -p Server1 -t 3
pingタイムアウトを3秒に設定し、Server1の起動状態を調べる。
  • -p または -w とともに指定する必要があります。
  • ping のタイムアウトはデフォルトで1秒となっています。
  • 今どきのネットワークであれば、ping の応答は1秒以内で返ってくると思いますが、pingの応答が1秒以上かかってしまうことがあるような場合、このオプションで適切な値に設定してください。

 

-i :正規表現で大文字小文字を区別しない

-l, -r で、正規表現の処理を行う際に、大文字小文字を区別しない設定にします。

 

-c filename :設定ファイル名を指定する

読み込む設定ファイルを指定します。パラメータには設定ファイルの絶対パス名、または、ユーザ名を指定します。

ユーザ名を指定した場合、設定ファイルは C:\Users\<ユーザ名>\AppData\Roaming\nWOL\nWOL.conf となります。

読み込む設定ファイルには適切なアクセス権が付与されている必要があります。

コマンド例 説明
nwolc -c "c:\Users\User Name\AppData\
Roaming\nWOL\nWOL.conf" -l
絶対パスで指定されたファイルを設定ファイルとして読み込み -l を実行する。
nwolc -c "User Name" -l
指定されたユーザの設定ファイルを読み -l を実行する。

 

-o filename :コンソール出力をファイルにリダイレクトする

コンソール出力をファイルにリダイレクトします。ファイル名は絶対パスでなければなりません。ファイルが存在する場合、追記モードで出力されます。

コマンド例 説明
nwolc -o "c:\Windows\Temp\out.log" -l
コンソール出力を指定されたファイルにリダイレクトし、-l を実行する。

 

-v :処理状況を表示する

処理状況を示すより多くのメッセージを表示します。

 

-n :メッセージの表示をしない

メッセージの表示を一切行わないようにします。

 

-? :ヘルプの表示

ヘルプを表示します。オプション無しで nWOLc を実行してもヘルプが表示されます。

 

戻り値

nWOLc の戻り値は、基本的には、正常終了は 0、何らかのエラーがあった場合(コンソール表示に "Error:" が表示された場合)は1となります。

-p -w の場合は、ホストが起動中であれば 0、それ以外の場合は 1 となります。

また、-a -h -r いずれかと -w が同時に指定された場合、 マジックパケット送信処理でエラーが表示されていても、-w の戻り値が返されます。

 

-m, -p, -w オプションは nWOLc.exe 単独でも使用可能

nWOLc.exe は基本的には nWOL で登録されているホストに対して処理を行いますが、-m オプション、および、-p, -w をIPアドレス指定とした場合については、nWOLの設定情報を使用しないため、nWOLc.exe 単独で使用できます。

 

nWOL、nWOLc で使用する正規表現の仕様

nWOL, nWOLcで使用する正規表現の仕様については、以下のリンクを参照してください。

Regular Expression Language - Quick Reference」(マイクロソフトのページ)

 

 

【関連記事・関連コンテンツ】

 

コメントをお送りください
お名前:
コメント:
コメントの公開: