frx 命令行实用工具

项目
11/10/2023

frx 是一个命令行实用工具，提供 FSLogix 配置的管理和配置。该实用工具管理规则、配置文件和容器、搜索、凭据管理器和其他杂项函数。

命令

命令	说明
帮助？	显示此帮助消息
version	显示已加载组件的版本

规则

命令	说明
add-redirect	添加新文件夹重定向
add-rule	添加指定规则
create-ruleset	创建规则集
del-redirect	删除活动文件夹重定向
del-rule	删除指定的规则
list-redirects	列出当前活动文件夹重定向
list-rules	列出当前加载的规则
reload-rules	从缓存重新加载规则

配置文件和虚拟容器

命令	说明
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	设置配置文件的文件夹重定向配置

搜索组件

命令	说明
reset-user-search-db	对用户的搜索索引数据库重新编制索引。

凭据管理器密钥管理

命令	说明
add-secure-key	将安全密钥添加到凭据管理器
del-secure-key	从凭据管理器中删除安全密钥
list-secure-key	列出凭据管理器中包含的密钥

杂项

命令	说明
create-junction	创建指向目标卷或文件夹的交接点
enable-shnot	启用 shell 刷新通知
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

要返回的数据的十六进制表示形式。

特殊变量

可在或-dest参数中使用-dest-parent。

变量	说明
`__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

重新加载规则。可以特定于一个规则文件，或适用于所有规则。

注意

重新加载规则不会影响易失性规则。

    frx reload-rules -filename <path>

示例

    frx reload-rules -filename Rules.fxr

可选参数

-filename

指定要重新加载的规则文件。

配置文件和虚拟容器

frx copy-profile

警告

如果本地配置文件大小超过 5 GB，则必须指定 -size-mbs 大小大于 5000 的参数。

将用户配置文件复制到 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

指定为用户名或 DOMAIN\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

将文件夹及其所有子文件夹和文件一起移动到 VHD（X）磁盘。

    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

指定用户名或 DOMAIN\username。

-sid

指定用户 SID 而不是使用 -username

凭据管理器密钥管理

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

启用 shell 刷新通知

    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