frx コマンドラインユーティリティ

[アーティクル]
01/10/2024

frx は、FSLogix 構成の管理と設定を行うためのコマンドラインユーティリティです。このユーティリティは、ルール、プロファイルとコンテナー、検索、資格情報マネージャー、その他の機能を管理します。

コマンド

command	説明
help、?	このヘルプメッセージを表示する
version	読み込まれたコンポーネントのバージョンを表示する

ルール

command	説明
add-redirect	新しいフォルダーリダイレクトを追加する
add-rule	指定した規則を追加する
create-ruleset	ルールセットを作成する
del-redirect	アクティブなフォルダーリダイレクトを削除する
del-rule	指定したルールを削除する
list-redirects	現在アクティブなフォルダーリダイレクトを一覧表示する
list-rules	現在読み込まれているルールを一覧表示する
reload-rules	キャッシュからルールを再読み込みする

プロファイルと仮想コンテナー

command	説明
copy-profile	ユーザーのプロファイルを VHD または VHDX にコピーする
copyto-vhd	フォルダーとその内容を VHD または VHDX にコピーする
create-vhd	VHD または VHDX を作成して書式設定する
edit-profile	VHD または VHDX に含まれるプロファイルの内容を編集する
begin-edit-profile	指定した VHD または VHDX とレジストリハイブをアタッチする
end-edit-profile	指定した VHD または VHDX とレジストリハイブをデタッチする
export-profilecfg	プロファイル構成設定をファイルにエクスポートする
import-profilecfg	ファイルからプロファイルの構成設定をインポートする
migrate-vhd	既存の VHD の内容を新しい VHD に移行する
moveto-vhd	フォルダーとその内容を VHD または VHDX に移動する
set-profile-redir	プロファイルフォルダーのリダイレクトの構成を設定する

コンポーネントの検索

command	説明
reset-user-search-db	ユーザーの検索インデックスデータベースのインデックスを再作成する

資格情報マネージャーのキー管理

command	説明
add-secure-key	セキュリティで保護されたキーを資格情報マネージャーに追加する
del-secure-key	資格情報マネージャーからセキュリティ保護されたキーを削除する
list-secure-key	資格情報マネージャーに含まれているキーを一覧表示する

その他

command	説明
create-junction	ターゲットボリュームまたはディレクトリへの接合ポイントを作成する
enable-shnot	シェル更新通知を有効にする
regfont	フォントをシステムのフォントテーブルに登録する
report-assignment	ルールセットの適用性レポート
show-junction-info	ジャンクションポイントに関する情報を表示します
unregfont	システムフォントテーブルからフォントを削除する
start-agent	エージェントを構成するすべてのドライバーとサービスを開始する
stop-agent	エージェントを構成するすべてのドライバーとサービスを停止する

frx バージョン

読み込まれたコンポーネントのバージョンを表示する

例

    frx version

ルール

frx add-redirect

仮想化ドライバーの新しいパスリダイレクトを追加する

    frx add-redirect -src <path>
                     -dest <path>

必須パラメーター

-source または -src

リダイレクトするソースパスを指定します。

-destination または -dest

リダイレクトターゲットとして機能するパスを指定します。

例

    frx add-redirect -src C:\mysource -dest d:\mytest
    frx add-redirect -src C:\mysource -dest \\?\VolumeXXXXX\Test

frx add-rule

特定のルールを追加します。

    frx add-rule -hide <params>
                 -printer <params>
                 -redirect <params>
                 -specific-data <params>
                 -vhd-attach <params>

例

    frx add-rule -hide -src-parent C:\Windows
    frx add-rule -hide -src-parent \Registry\User\*\Software -src MySoftware  
    frx add-rule -redirect -src-parent C:\Windows -src=test.ini -dest-parent __USER_PROFILE_PATH__ -dest test.ini
    frx add-rule -specific-data -src-parent \Registry\Machine\Software -src Value -datatype DWORD -data 42000000
    frx add-rule -vhd-attach -src-parent C:\MyVolFolder -dest C:\VHDs\mydisk.vhd

必須パラメーター

-src-parent

ルールが適用される親ディレクトリ/キーまたはプリンター。

省略可能なパラメーター

-src

ファイルまたは値の名前

-dest-parent

宛先ディレクトリまたはキー (リダイレクトルールのみ)。

-dest

宛先ファイルまたは値 (リダイレクトルールのみ)。

-no-copy

アイテムが存在しない場合は、リダイレクト時に空のコピーを作成します (既定では、ソースアイテムをコピーします)。

-volatile

コンピューターの再起動後も保持されない揮発性ルール。

-datatype

返される特定のデータの種類 (SZ、DWORD)。

-data

返されるデータの 16 進数表現。

特殊変数

-dest-parent パラメーターまたは -dest パラメーターで使用できます。

変数	説明
`__USER_SID__`	ユーザーの SID
`__USER_NAME__`	ユーザーのユーザー名
`__USER_PROFILE_PATH__`	ユーザープロファイルへのパス

frx create-ruleset

指定したインストールディレクトリをスキャンしてルールセットを作成します。

    frx create-ruleset -filename <path>
                       -install-dir <path>
                       -ARP-keyname <path>

例

    frx create-ruleset-name Chrome -install-dir "C:\Program Files\Google\Chrome\Application" -ARP-keyname "HKLM\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Google Chrome"

パラメーター

-filename

作成するファイルの名前を指定します。

-install-dir

スキャンするアプリケーションのインストールパスを指定します。

-ARP-keyname

プログラムの追加と削除のレジストリの場所を指定します。

frx del-redirect

アクティブなリダイレクトを削除します。

    frx del-redirect -source <path>

例

    frx del-redirect -source C:\MyData\Docs

パラメーター

-source

リダイレクトを削除するソースフォルダーを指定します。

frx del-rule

指定されたルールを削除します。

    frx del-rule -src-parent <path>
                 -src <path>

例

    frx del-rule -src-parent C:\Windows -src test.ini
    frx del-rule -hide -src-parent \Registry\User\*\Software -src MySoftware

必須パラメーター

-src-parent

ルールを適用する親ディレクトリまたはキー。

省略可能なパラメーター

-src

ファイルまたは値の名前。

frx list-redirects

現在アクティブなフォルダーリダイレクトを一覧表示します。

    frx list-redirects

frx list-rules

システムに読み込まれているすべてのルールを一覧表示します。

    frx list-rules -verbose

省略可能なパラメーター

-verbose

ルールに関する追加情報を表示します。

frx reload-rules

ルールを再読み込みします。ルールの 1 つのファイルに固有にすることも、すべてのルールに適用することもできます。

Note

再読み込み規則は、揮発性ルールには影響しません。

    frx reload-rules -filename <path>

例

    frx reload-rules -filename Rules.fxr

省略可能なパラメーター

-filename

再読み込みするルールファイルを指定します。

プロファイルと仮想コンテナー

frx copy-profile

警告

ローカルプロファイルのサイズが 5 GB を超える場合は、サイズが 5000 を超える -size-mbs パラメーターを指定する必要があります。

ユーザーのプロファイルを VHD または VHDX にコピーします。 VHD または VHDX ファイルが存在しない場合は作成されます。

    frx copy-profile -filename <path>
                     -username <username or domain\username>
                     -sid <sid>
                     -size-mbs <int>
                     -vhdx-sector-size <int>
                     -dynamic <1 or 0>
                     -src-parent <path>
                     -verbose <switch>
                     -profile-path <path>
                     -label <string>
                     -redirections <path>

例

5 GB 未満のローカルプロファイル

    frx copy-profile -filename C:\Profile.vhd -username CONTOSO\msmith

5 GB を超えるローカルプロファイル

    frx copy-profile -filename C:\Profile.vhd -username CONTOSO\msmith -size-mbs 30000

必須パラメーター

-filename

VHD(x) ファイルへのパスを指定します。

-username

ユーザー名またはドメイン\ユーザー名として指定

-sid

プロファイルを識別するために -username の代わりに使用されます。

省略可能なパラメーター

-size-mbs

新しい VHD/VHDX のMB 数のサイズ

-vhdx-sector-size

VHDX セクターサイズ

-dynamic

動的な場合は 1、固定ディスクの場合は 0 に設定

-src-parent

差分ディスクの親 VHDX ファイルのパス

-verbose

詳細出力を有効にします

-profile-path

プロファイルパスを指定

-label

ディスクボリュームラベル (既定値はプロファイル)

-redirections

プロファイルにコピーするリダイレクトファイルを指定します

frx copyto-vhd

フォルダーとその内容を VHD または VHDX にコピーする

    frx copyto-vhd -filename <path>
                   -src <path>
                   -dest <path>
                   -size-mbs <int>
                   -vhdx-sector-size <int>
                   -dynamic <1 or 0>
                   -verbose <switch>
                   -src-parent <path>
                   -label <string>

例

    frx copyto-vhd -filename C:\mydisk.vhd -src C:\data

必須パラメーター

-filename

VHDX ファイルへのパスを指定

-src

コピー元のフォルダーを指定

省略可能なパラメーター

-dest

VHDX ファイル内のターゲットフォルダーを指定します。既定の宛先は VHDX ルートフォルダーです。

-size-mbs

新しい VHD/VHDX のMB 数のサイズ

-vhdx-sector-size

VHDX セクターサイズ

-dynamic

動的な場合は 1、固定ディスクの場合は 0 に設定

-verbose

詳細出力を有効にします

-label

ディスクボリュームラベル (既定値はプロファイル)

frx create-vhd

VHD または VHDX を作成して書式設定します。既定では、VHD または VHDX は 30 GB になり、動的にサイズ設定されます。

    frx create-vhd -filename <path>
                   -size-mbs <int>
                   -vhdx-sector-size <int>
                   -dynamic <1 or 0>
                   -src-parent <path>
                   -label <string>

例

    frx create-vhd -filename C:\Profile.vhd

必須パラメーター

-filename

VHDX ファイルへのパスを指定

省略可能なパラメーター

-size-mbs

新しい VHD/VHDX のMB 数のサイズ

-vhdx-sector-size

VHDX セクターサイズ

-dynamic

動的な場合は 1、固定ディスクの場合は 0 に設定

-src-parent

差分ディスクの親 VHDX ファイルのパス

-label

ディスクボリュームラベル (既定値はプロファイル)

frx edit-profile

指定した VHD または VHDX をアタッチし、エクスプローラーウィンドウとレジストリエディターを開いて、プロファイルの内容を表示および編集できるようにします。

    frx edit-profile -filename <path>

例

    frx edit-profile -filename C:\Profile.vhd

パラメーター

-filename

VHDX ファイルへのパスを指定

frx begin-edit-profile

指定した VHD または VHDX をアタッチし、レジストリハイブをアタッチして、プロファイルの内容を表示および編集できるようにします。

    frx begin-edit-profile -filename <path>

例

    frx begin-edit-profile -filename C:\Profile.vhd

パラメーター

-filename

VHDX ファイルへのパスを指定

frx end-edit-profile

指定した VHD または VHDX とレジストリハイブをデタッチする

    frx end-edit-profile -cookie <string>
                         -filename <path>

例

    frx end-edit-profile -cookie 4876 -filename C:\Profile.vhd

パラメーター

-cookie

begin-edit-profile の呼び出しから出力された Cookie を指定します

-filename

VHDX ファイルへのパスを指定

frx export-profilecfg

プロファイルの構成設定とインクルードグループおよび除外グループのメンバーシップをファイルにエクスポートします。後で import-profilecfg コマンドを使って設定をインポートできます。

    frx export-profilecfg -filename <path>

例

    frx export-profilecfg -filename my_configuration.frxconfig

パラメーター

-filename

保存する構成データのファイルを指定します。

frx import-profilecfg

プロファイルの構成設定とインクルードグループおよび除外のグループのメンバーシップをファイルにインポートします。このファイルは export-profilecfg コマンドを使用して生成できます。

    frx import-profilecfg -filename <path>

例

    frx import-profilecfg -filename my_configuration.frxconfig

パラメーター

-filename

保存する構成データのファイルを指定します。

frx migrate-vhd

VHD または VHDX を作成、書式設定し、ソース VHD の内容をミラーします。既定では、VHD または VHDX は 30 GB になり、動的にサイズ設定されます。

    frx migrate-vhd -src <path>
                    -dest <path>
                    -size-mbs <int>
                    -vhdx-sector-size <int>
                    -dynamic <0 or 1>

例

    frx migrate-vhd -src C:\old\Profile.vhd -dest C:\new\Profile.vhd

必須パラメーター

-src

移行元の VHDX ファイルへのパスを指定

-dest

新しい VHDX ファイルの名前を指定します。

省略可能なパラメーター

-size-mbs

新しい VHD/VHDX のMB 数のサイズ

-vhdx-sector-size

VHDX セクターサイズ

-dynamic

動的な場合は 1、固定ディスクの場合は 0 に設定

frx moveto-vhd

フォルダーおよびすべてのサブフォルダーとファイルを VHDX ディスクに移動します。

    frx moveto-vhd -filename <path>
                   -src <path>
                   -dest <path>
                   -size-mbs <int>
                   -vhdx-sector-size <int>
                   -dynamic <1 or 0>
                   -verbose <switch>
                   -src-parent <path>
                   -label <string>

例

    frx moveto-vhd -filename C:\mydisk.vhd -src C:\data

必須パラメーター

-filename

VHDX ファイルへのパスを指定

-src

移動元のフォルダーを指定する

省略可能なパラメーター

-dest

VHDX ファイル内のターゲットフォルダーを指定します。既定の宛先は VHDX ルートフォルダーです。

-size-mbs

新しい VHD/VHDX のMB 数のサイズ

-vhdx-sector-size

VHDX セクターサイズ

-dynamic

動的な場合は 1、固定ディスクの場合は 0 に設定

-verbose

詳細出力を有効にします

-label

ディスクボリュームラベル (既定値はプロファイル)

frx set-profile-redir

プロファイルフォルダーのリダイレクトの構成を設定する

    frx set-profile-redir -filename <path>
                          -redirections <path>
                          -no-redirections <switch>

例

    frx set-profile-redir -filename C:\Profile.vhd -redirections C:\redir.xml

必須パラメーター

-filename

VHDX ファイルへのパスを指定

省略可能なパラメーター

-redirections

プロファイルにコピーするリダイレクトファイルを指定します。

-no-redirections

プロファイルから既存のリダイレクトを削除します。

コンポーネントの検索

frx reset-user-search-db

ユーザーの検索インデックスデータベースのインデックスを再作成します。

    frx reset-user-search-db -username <username or domain\username>
                             -sid <sid>

例

    frx reset-user-search-db -username DOMAIN\USERNAME

パラメーター

-username

ユーザー名またはドメイン\ユーザー名を指定します。

-sid

-username を使用する代わりにユーザー SID を指定する

資格情報マネージャーのキー管理

frx add-secure-key

セキュリティで保護されたキーを資格情報マネージャーに追加する

    frx add-secure-key -key <string>
                       -value <string>

例

    frx add-secure-key -key fslogix -value secretStringABC123

パラメーター

-key

資格情報のキー名を指定します。

-value

目的のキーの値を指定します。

frx del-secure-key

資格情報マネージャーからセキュリティ保護されたキーを削除する

    frx del-secure-key -key <string>

例

    frx del-secure-key -key fslogix

パラメーター

-key

資格情報のキー名を指定します。

frx list-secure-key

資格情報マネージャーに含まれているキーを一覧表示する

    frx list-secure-key

その他

frx create-junction

ターゲットボリュームまたはディレクトリへの接合ポイントを作成する

    frx create-junction -src <path>
                        -dest <path>
                        -name <string>

例

    frx create-junction -src E:\ -dest \\Volume{2dd97d8a-3bab-11e1-b9ff-080027e238aa}

必須パラメーター

-src

接合ポイントを追加するドライブまたはディレクトリを指定します。

-dest

ターゲットのフォルダーまたはボリュームを指定します。

省略可能なパラメーター

-name

表示名 (省略可能)

frx enable-shnot

シェル更新通知を有効にする

    frx enable-shnot -true <switch>
                     -false <switch>
                     -force <switch>

例

    frx enable-shnot -force

省略可能なパラメーター

-true

通知を有効にする

-false

通知を無効にする

-force

有効になっている場合は、強制的に通知をすぐに送信します。

frx regfont

フォントをシステムのフォントテーブルに登録する

    frx regfont -filename <path>

例

    frx regfont -filename C:\myfont.ttf

パラメーター

-filename

フォントファイルへのパスを指定します。

frx report-assignment

割り当てファイルと Active Directory を分析して、ルールセットの適用性と非適用性についてレポートします。

    frx report-assignment -filename <path>
                          -username <LDAP>
                          -verbose <switch>
                          -csv <switch>

例

    frx report-assignment -filename C:\test.fxa -username "CN=User,DC=domain"

必須パラメーター

-filename

割り当てファイルへのパスを指定します。

省略可能なパラメーター

-username

指定されたユーザー (識別名) の割り当てファイルについて適用性を報告します。

-verbose

詳細出力を有効にします。

-csv

カンマ区切り値 (CSV) 形式での出力を有効にします。

frx show-junction-info

指定したフォルダーの接合ポイント情報を表示します。

    frx show-junction-info -src <path>

例

    frx show-junction-info -src E:\

パラメーター

-src

情報の収集元のドライブまたはフォルダーを指定します。

frx unregfont

システムフォントテーブルからフォントを削除する

    frx unregfont -filename <path>

例

    frx unregfont -filename C:\myfont.ttf

パラメーター

-filename

フォントファイルへのパスを指定します。

frx start-agent

エージェントを構成するすべてのドライバーとサービスを開始する

    frx start-agent

frx stop-agent

エージェントを構成するすべてのドライバーとサービスを停止する

    frx stop-agent

次の方法で共有

frx コマンドライン ユーティリティ

コマンド

ルール

プロファイルと仮想コンテナー

コンポーネントの検索

資格情報マネージャーのキー管理

その他

frx バージョン

例

ルール

frx add-redirect

必須パラメーター

例

frx add-rule

例

必須パラメーター

省略可能なパラメーター

特殊変数

frx create-ruleset

例

パラメーター

frx del-redirect

例

パラメーター

frx del-rule

例

必須パラメーター

省略可能なパラメーター

frx list-redirects

frx list-rules

省略可能なパラメーター

frx reload-rules

例

省略可能なパラメーター

プロファイルと仮想コンテナー

frx copy-profile

例

必須パラメーター

省略可能なパラメーター

frx copyto-vhd

例

必須パラメーター

省略可能なパラメーター

frx create-vhd

例

必須パラメーター

省略可能なパラメーター

frx edit-profile

例

パラメーター

frx begin-edit-profile

例

パラメーター

frx end-edit-profile

例

パラメーター

frx export-profilecfg

例

パラメーター

frx import-profilecfg

例

パラメーター

frx migrate-vhd

例

必須パラメーター

省略可能なパラメーター

frx moveto-vhd

例

必須パラメーター

省略可能なパラメーター

frx set-profile-redir

例

必須パラメーター

省略可能なパラメーター

コンポーネントの検索

frx reset-user-search-db

例

パラメーター

資格情報マネージャーのキー管理

frx コマンドラインユーティリティ