FSLogix Command-Line Utility command reference

frx location

In a default FSLogix Apps installation, frx.exe is found in ..\ProgramFiles\FSLogix\Apps. For additional information please see FSLogix installed components and functions

Redirection

Command

add-redirect

Description

Add a new path redirection for the virtualization (VT) driver

-src= (required)

Specifies the source path to redirect

-dest= (required)

Specifies the path to act as redirection target

Example

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

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

frx add-redirect -src=<Source Path> -dest=<Path of redirection target>

Hiding Rule

Command

add-rule -hide

Description

To add a hiding rule, specify the following options with add-rule:

-hide (required) -src-parent= (required) If this rule is for a directory or registry key, the directory or key path is entered here. If this is for a file or registry value, the parent directory or parent registry key path is entered here.

-src= (optional)

represents the name of the file or registry value. This parameter is not used when the rule is targeted for a directory or registry key.

-volatile (optional)

This option tells the system not to persist this Rule. The Rule will disappear when the driver is stopped (either manually or if the system is restarted).

Example

frx add-rule -hide -src-parent="C:\users\admin\desktop" -src="chrome.lnk" -volatile

frx add-rule -hide -src-parent=<folder or directory key>

Redirect Rule

Command

add-rule -redirect

Description

To add a redirect rule, specify the following options with add-rule:

-redirect (required) -src-parent= (required) If this rule is for a directory or registry key, the source directory or source key path is entered here. If this is for a file or registry value, the source parent directory or source parent registry key path is entered here.

-src= (optional)

represents the name of the source file or source registry value. This parameter is not used when the source object of a rule is a directory or registry key.

-dest-parent= (required)

If this rule is for a directory or registry key, the destination directory or destination key path is entered here. If this is for a file or registry value, the destination parent directory or destination parent registry key path is entered here.

-dest= (optional)

represents the name of the destination file or destination registry value. This parameter is not used when the destination object of a rule is a directory or registry key.

-no-copy (optional)

By default, when a redirect is about to happen, the FSLogix Apps Agent checks to see if the destination file, directory, registry key, or registry value exists. If it does exist, the request is simply redirected. If the object does not exist, the object will be created (and in the case of a file or registry value, the contents of the source object copied to the destination object) and then the redirection will happen. This flag tells the system not to do this check and to simply redirect.

-volatile (optional)

This option tells the system not to persist this Rule. The Rule will disappear when the driver is stopped (either manually or if the system is restarted).

Example

frx add-rule -redirect -src-parent="C:\windows" -src="bad.ini" -dest-parent="USER_PROFILE_PATH\badprogram" -dest="bad.ini"

frx add-rule -redirect -src-parent=<folder or key name>

Add Secure Key to Credential Manager

Command

add-secure-key

Description

Places information in the Windows Credential Manger (Credential Vault) under the SYSTEM user with fslogix/ prefix to be used with Azure Cloud Cache Connection String

-key = name of key to be used in Azure Connection String

NOTE: fslogix/ is automatically prefixed to the key when the key is generated with frx.exe add-secure key

-value = this is the value that is intended to be secured, it is anticipated that this will be utilized with the Azure Account Key.

The secure key may be accessed in CCDLocations when using the azure Type by placing the key name with pipes.

Example

Use in registry setting as: type=smb,connectionString=\FILESERVER\SharedFolder;type=azure,connectionString="DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=|fslogix/myAccountKey|;EndpointSuffix=mySuffix"

frx add-secure-key -key=<key variable name> -value=<value of key to be assigned to variable name in credential manager>

Edit Profile

Command

begin-edit-profile

Description

Attaches the specified VHD or VHDX and attaches the registry hive so the contents of the profile can be viewed and edited. Prints out a cookie that should be handed back with a end-edit-profile command line to clean up.

-filename (required) Specifies the path to the VHD(X) file \n );

Example

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

frx begin-edit-profile -filename <path to profile VHD>

Copy folder to VHD

Command

copyto-vhd

Description

Copies a folder along with all sub folders and files to a VHD container.

-filename= (required)

Full file path and name of the VHD file to be created

-src= (required)

Full path to source folder

-size-mbs= (optional)

Size of the VHD in number of MBs

-vhdx-sector-size= (optional)

VHDX only. Specifies the sector size to use.

-dynamic=<0|1> (optional)

Set to “1” for a dynamic sizing VHD, or “0” for a full allocation VHD

-src-parent= (optional)

Path to a parent VHD. If specified, the new VHD will be created as a differencing disk.

-label=

Label to assign to the new volume.

Example

frx copyto-vhd -filename=<VHD file for folder to be copied to> -src=<folder to be copied to vhd>

Copy Profile to VHD

Command

copy-profile

Description

Copies the specified local user profile to a VHD or VHDX container. If the VHD file does not exist, it will be created, formatted, as appropriate.

-filename= (required)

Full file path and name of the VHD file to be created

-username= (required unless sid is specified)

‘username’ or ‘domain\username’

-sid= (required unless username is specified)

Can be used instead of username to identify the profile

-size-mbs= (optional)

Size of the VHD in number of MBs

-vhdx-sector-size= (optional)

VHDX only. Specifies the sector size to use.

-dynamic=<0|1> (optional)

Set to “1” for a dynamic sizing VHD, or “0” for a full allocation VHD

-src-parent= (optional)

Path to a parent VHD. If specified, the new VHD will be created as a difference disk.

-profile-path= (optional)

Path to the folder that contains the profile. If this is not specified, the profile location will be read from the registry.

-verbose (optional)

Enables verbose output

Example

frx copy-profile -filename=<VHD file for folder to be copied to> -username=<username for profile>

Create junction to specified VHD

Command

create-junction

Description

Creates a junction point to a target volume or directory.

-src=(required)

Specifies the drive or directory where the junction point will be added.

-dest=(required)

Specifies the target directory or volume.

-name

Indicates the optional display name.

Example

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

frx creae-junction -src=<source folder for redirection> -dest=<destination vhd for junction>

Create an FSLogix Rule Set

Command

create-ruleset

Description

Creates a Rule Set by scanning the specified install directory

-filename (required)

Specifies the name of the file to be created.

-install-dir (required)

Specifies the installation path of the application to be scanned.

-ARP-keyname (required)

Specifies the Add/Remove Program registry location

Example

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

frx create-ruleset -filename=<name of file to be created> -install-dir=<specifies the path where the application to be scanned is installed> -ARP-keyname<add remove program registry location>

Create new VHD

Command

create-vhd

Description

-filename= (required)

Full file path and name of the VHD file to be created

-size-mbs= (optional)

Size of the VHD in number of MBs

-vhdx-sector-size= (optional)

VHDX only. Specifies the sector size to use.

-dynamic=<0|1> (optional)

Set to “1” for a dynamic sizing VHD, or “0” for a full allocation VHD

-src-parent= (optional)

Path to a parent VHD. If specified, the new VHD will be created as a differencing disk.

-label=

Label to assign to the new volume.

Example

frx create-vhd -filename=<vhd file to be created>

Delete active redirection

Command

del-redirect

Description

Delete an active VT driver redirection

-src= (required)

Identifies the redirect source path of the redirection to be removed

Example

frx del-redirect -src=C:\MyData\Docsfrx del-redirect -src C:\MyData\Docs

frx del-redirect -src=<path for redirection to be removed>

Delete FSLogix rule

Command

del-rule

Description

Deletes a rule. To delete a rule you must identify the rule to remove by specifying the src-parent and src (if any).

-src-parent= (required)

If this rule is for a directory or registry key, the directory or key path is entered here. If this is for a file or registry value, the parent directory or parent registry key path is entered here.

-src= (optional)

represents the name of the file or registry value. This parameter is not used when the object of a rule is a directory or registry key.

Example

frx del-rule -src-parent="C:\users\admin\desktop" -src="chrome.lnk"

frx del-rule -src-parent="C:\windows" -src="bad.ini"

frx del-rule -src-parent=<source parent for rule to be deleted> -src=<source to be deleted>

Delete secure FSLogix key from Credential Manager

Command

del-secure-key

Description

Deletes a secure key set with add-secure-key

-key = key name to be deleted

NOTE: the key name that is passed here does NOT include the fslogix/ prefix

Example

frx del-secure-key -key<name of key only without fslogix/ prefix>

Edit Profile Container Profile

Command

edit-profile

Description

Attaches the specified VHD or VHDX and opens Explorer and Regedit windows for the container contents. Press any key and the windows will be closed and the VHD detached from the system.

-filename= (required)

Full file path and name of the VHD file to be attached

Example

frx edit-profile=<vhd file that contains profile to be edited>

Enable Shell Refresh Notification

Command

enable-shnot

Example

frx enable-schnot

End editing profile

Command

end-edit-profile

Description

Detaches the specified VHD or VHDX and the registry hive.

-cookie (required)

Specifies the cookie printed out from the begin-edit-profile call

-filename (required)

Specifies the path to the VHD(X) file

Example

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

frx end-edit-profile -cookie=<cookie provided from begin edit profile> -filename=<filename of vhd containing the profile being edited>

Export Profile Configuration

Command

export-profilecfg

Description

Exports profile configuration settings and inclusion/exclusion group memberships to a file. The settings can be imported later with the import-profilecfg command or with the Profile Configuration Tool

-filename (required)

Specifies the file/location for the configuration data to be stored.

Example

frx export-profilecfg -filename=C:\profiles.frxconfig

frx export-profilecfg -filename=<folder/file where the data will be exported>

Help

Command

help

Description

Displays frx help without parameters, or help for specific command if specified

Example

frx help

frx help

frx help add-rule

frx help

Import Profile Configuration

Command

import-profilecfg

Description

Import profile configuration settings from a file.

-filename (required)

The full path to the profile configuration file.

Example

frx import-profilecfg -filename=C:\data.frxconfig

frx import-profilecfg -filename=<folder/file containing exported profile configuration>

List active FSLogix redirects

Command

list-redirects

Example

frx list-redirects

List active FSLogix Rules

Command

list-rules

Example

frx list-rules

List all secure key names in Credential Manager with a fslogix/ prefix

Command

list-secure-key

Example

frx list-secure-key

Move folder and subfolders to VHD

Command

moveto-vhd

Description

-filename= (required)

Full file path and name of the VHD file to be created

-src= (required)

Full path to source folder

-size-mbs= (optional)

Size of the VHD in number of MBs

-vhdx-sector-size= (optional)

VHDX only. Specifies the sector size to use.

-dynamic=<0/1> (optional)

Set to “1” for a dynamic sizing VHD, or “0” for a full allocation VHD

-src-parent= (optional)

Path to a parent VHD. If specified, the new VHD will be created as a differencing disk.

-label=

Label to assign to the new volume.

Example

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

frx moveto-vhd -filename=<folder/filename for vhd to move folder to> -src=<folder to be moved to VHD>

Migrate contents of current VHD to a new VHD

Command

migrate-vhd

Description

-src (required)

Specifies the path to the source VHD(X) disk.

-dest (required)

Specifies the new VHD(X) filename.

-size-mbs= (optional)

Size of the VHD in number of MBs

-vhdx-sector-size= (optional)

VHDX only. Specifies the sector size to use.

-dynamic=<0/1> (optional)

Set to “1” for a dynamic sizing VHD, or “0” for a full allocation VHD

Example

frx migrate-vhd -src C:\old.vhdx -dest C:\new.vhdx -dynamic 1

frx migrate-vhd -src=<folder/file of vhd to migrate> -dest=<>

Register a font to the font table

Command

regfont

Description

Registers a font in the system font table.

-filename (required)

Specifies the path to the font file.

Example

frx regfont -filename=<path for font file>

Reload FSLogix rules

Command

reload-rules

Description

Instructs FSLogix driver to unload and reload all rules

Example

frx reload-rules

Reports the applicability of a specified rule set by comparing the rule set to active directory

Command

report-assignment

Description

-filename (required)

Specifies the path to the Assignment File.

-username (optional)

Reports the applicability of the Assignment File for the user specified in FQDN syntax.

-verbose (optional)

Enables verbose output.

-csv (optional)

Specifies that output should be in CSV format.

Example

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

frx report-assignment -filename=<rules file to be analyzed>

Reset the user search database

Command

reset-user-search-db

Description

Queue's a windows search re-index for the specified user. To be used with the FSLogix Multi-user Search Roaming feature.

-username (required)

A user's DOMAIN\USERNAME

-sid

A user's SID can be used instead of a username .

Example

frx reset-user-search-db -username=domain\user

frx reset-user-search-db -username=<domain\user whos database is to be reset>

Update active profile redirection

Command

set-profile-redir

Description

Sets the profiles folder redirections configuration.

-filename (required)

Specifies the path to the VHD(X) file

-redirections (optional)

Specify the redirections file to copy to the profile

-no-redirections (optional)

Remove any existing redirections from the profile

Example

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

frx set-profile-redir -filename=<vhd file to be redirected>

Command

show-junction-info

Description

Shows information about a junction point

-src (required)

Specifies the path to the junction point.

Example

frx show-junction-info -src=C:\TestDir

frx show-junction-info -src=<fold with assigned junction>

Font removal from system font table

Command

unregfont

Description

Removes a font from the system font table.

-filename (required)

Specifies the path to the font file.

Example

frx unregfont -filename<font file to be removed>

Command

Description

Example

frx 

Display FSLogix version information

Command

version

Description

Displays the versions for the command-line, the service, and the driver.

Version information is queried dynamically from the service and the driver so that information for currently running components is shown. It is possible, although unlikely, that the running components could be a different version than what is installed. If the service or the driver is not loaded, no version information will be displayed for that component.

Example

frx versions