コマンドライン リファレンス

コマンド

11 個のコマンドがあります。snapshot は名詞で、後ろに語が続きます。tool も名詞で、単独で実行するとツールの一覧を表示します。

bws list [--query TEXT] [--signatures] [--memory] [--required-by] [--follow-network] [--json] [--timing]
bws show NAME [--full] [--follow-network] [--json] [--timing]
bws stop|start|restart NAME [--dry-run] [--dependents] [--timeout SECONDS] [--json] [--timing]
bws kill NAME [--force] [--restart] [--dry-run] [--dependents] [--timeout SECONDS] [--json] [--timing]
bws start-type NAME automatic|delayed|manual|disabled [--stop] [--dry-run] [--json] [--timing]
bws snapshot create [FILE] [--note TEXT] [--follow-network] [--force] [--json] [--timing]
bws snapshot diff EARLIER LATER [--exit-code] [--json] [--timing]
bws snapshot diff EARLIER --live [--exit-code] [--json] [--timing]
bws history [NAME] [--json] [--timing]
bws tool
bws tool fix
bws tool fix NAME [--dry-run] [--timeout SECONDS] [--json] [--timing]
bws license [--components]
bws --help
bws --version

入力ミスのあるコマンドには、おそらく意図したものが提示され、頼んだものに近いことをする代わりに、コード 2 で終了します。

$ bws lst
There is no command lst. Did you mean list?

各コマンドの動作

例

以下のプランは、このページが説明するプログラムに対して --dry-run で確認したものです。何かを変更するコマンドは事前に確認しないため、実行前に確認するには --dry-run を使います。Spooler は任意のサービスを表します。ご自身のサービスの名前に置き換えてください。

bws list                                       このマシン上のすべてのサービスとドライバー
bws list --query "start:auto !status:running"  起動しているはずなのに起動していないもの
bws list --query "status:running" --memory     実行中の各エントリのプロセスが使っているもの
bws show Spooler                               1 つのエントリについてわかっているすべて
bws show Spooler --full                        本当に空のフィールドも含める

bws restart Spooler --dry-run                プランだけで、ほかには何もしない
bws restart Spooler --dependents             依存するものとともに再起動する
bws stop Spooler --dependents --timeout 120  進捗なしで 1 ステップあたり 2 分まで許可する
bws start-type WSearch delayed --dry-run     ほかの自動のエントリより少しあとに開始する
bws start-type Spooler disabled --stop       無効にして、同じプランで停止する

bws kill Spooler --dry-run          プロセスと、そこで動いているすべてのサービス
bws kill Spooler --restart          停止に失敗した場合のみプロセスを終了し、そのあとすべてを元に戻す
bws kill Spooler --force --dry-run  2 ステップではなく 1 ステップ。プロセスはすぐに終了される

bws snapshot create before.json --note "before the patch"  メモを中に入れて、マシンを固定する
bws snapshot diff before.json after.json                   2 つのファイル。2 日間、または 2 台のマシン
bws snapshot diff before.json --live                       ファイルを、現在のこのマシンと比較する
bws snapshot diff before.json --live --exit-code           同じ比較で、構成がドリフトしていれば 5 で終了する

bws history          System ログにあるスタートアップの種類の変更とインストールのすべて
bws history Spooler  1 つのサービスのスタートアップの種類の変更
bws history --json   同じ内容をドキュメントとして。ログと変更を含む

bws tool                      あるツールの一覧
bws tool fix                  クイック修正と、それぞれの背後にあるサービス
bws tool fix sound --dry-run  2 つのオーディオ サービスを再起動するプラン
bws tool fix printer          Print Spooler を、依存するものとともに再起動する

bws license --components  すべてのコンポーネント、バージョン、ライセンス、出所
bws --version             この実行ファイルのバージョン

# 起動しているはずなのに起動していないエントリを、オブジェクトとして
bws list --query "start:auto !status:running" --json | ConvertFrom-Json | Select-Object serviceName, displayName, status

# 署名のないファイルを、スプレッドシートへ
bws list --query "signed:no" --json | ConvertFrom-Json | Select-Object serviceName, binaryPath | Export-Csv unsigned.csv -NoTypeInformation

# 1 つのサービスが必要とするもの
(bws show Spooler --json | ConvertFrom-Json).dependsOn

# 終了コードで分岐する夜間チェック
bws snapshot diff C:\baselines\web01.json --live --exit-code > $null
switch ($LASTEXITCODE) {
  0 { 'no configuration drift' }
  5 { 'the configuration drifted' }
  default { "no clean answer, exit code $LASTEXITCODE" }
}

rem 最初のコマンドが正常に終了しなかった場合のみ、2 番目のコマンドを実行する
bws restart Spooler || echo the restart did not end cleanly

rem 遅延展開を有効にしたバッチファイルでは、! の前にキャレット（^）が必要
bws list --query "start:auto ^!status:running"

オプション

全部で 18 個あります。3 列目は、各オプションが属するコマンドです。使い道のないコマンドにオプションを渡すとエラーになり、その一覧が示されます。黙って無視されるフラグではありません。

終了コード

終わり方は 6 通りあり、それぞれがスクリプトにとって異なる意味を持ちます。データは標準出力に、それ以外はすべて標準エラーに出力されるので、bws list --json | jq が動作し、警告が JSON に混ざることはありません。

すべての JSON ドキュメントは純粋な ASCII です。ASCII 外の文字は 6 文字のエスケープとして書かれ、すべての JSON リーダーが元の文字に戻します。そのため、bws list --json > file.json は有効な UTF-8 になり、| ConvertFrom-Json は、コンソールがどのコードページに設定されていても正しく読み取ります。人が読むテキストでは、印字されずにターミナルを動かしてしまう文字（タブ、改行、エスケープシーケンス、方向の上書き）は、そのコードポイント <U+001B> として表示されます。

-- はオプションの終わりを示すので、ダッシュで始まる名前のサービスも指定できます。bws show -- -odd のようにします。ツールが提示するコマンドラインは PowerShell 向けに書かれています。スペースを含む名前は二重引用符で囲みます。cmd も同じように読みます。MSSQL$SQLEXPRESS のように、PowerShell が二重引用符の中で展開してしまう名前は、一重引用符で囲みます。

Ctrl+C には 3 つのレベルがあり、それぞれが次のレベルの代償を示します。最初のものは先に進むのをやめ、取り外したものを元に戻します。2 番目は、そのままの状態にして、レポートを表示します。3 番目はプロセスを終了します。手動で止めた実行は、すべてのステップが到達していても 4 で終了します。

コンソール ウィンドウを閉じることは、最初の Ctrl+C として扱われます。その後、Windows はプログラムに 5 秒を与え、その間にこのプログラムは先に進むのをやめ、停止したものを元に戻します。サインアウトとシャットダウンは、対応できる予告なしに終了させ、切断されたリモートセッションもそうなることがあります。

スケジュールされたタスクで

このツールが想定している形です。マシンが正常だとわかっているときに固定し、そのあと毎晩、まだ正常かどうかを尋ねます。

# マシンが稼働を開始する日
bws snapshot create C:\baselines\web01.json --note "after the build"

# 毎晩、スケジュールされたタスクから
bws snapshot diff C:\baselines\web01.json --live --exit-code --json > C:\logs\drift.json
#   0 - 構成のドリフトなし
#   5 - 構成がドリフトした。drift.json に内容が書かれる
#   3 - 実行されたが、すべてを読み取れなかった。そのため答えは部分的

ウィンドウは、同じエンジンのもう半分です。BetterWindowsServices-win-x64.zip に入っていて、各アーカイブが何であるかはダウンロードのページに書かれています。

ウィンドウの引数

BetterWindowsServices.exe は、人が使うための引数を 1 つ受け付けます。--catalogue は、ウィンドウのすべてのコンポーネントをすべての状態で表示する開発者向けのシートを開き、マシンからは何も読み取りません。もう 1 つの --carry は、ウィンドウが表示していた内容を、管理者として再起動する自分自身のコピーに引き渡す方法です。誰も手で入力するものではなく、そのウィンドウが書けるはずのないものが含まれていれば拒否されます。