2.6 Documentation is out of date

Our homepage https://docs.fslogix.com will always point to the latest documentation




Skip to end of metadata
Go to start of metadata

 

The command-line utility (frx.exe) lets you manage rule sets.  Listed below are all the commands the command-line utility accepts.

CommandDescription
add-rule -hide

Hiding Rule

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

  • -hide (required)
  • -src-parent=<directory> (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=<name> (optional)

<name> 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).

 

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

Redirect Rule

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

  • -redirect (required)
  • -src-parent=<directory or key name> (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=<name> (optional)

<name> 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=<directory or key name> (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=<name> (optional)

<name> 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).

 

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

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

 

-filename=<VHD filename> (required)

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

-src=<source folder> (required)

Full path to source folder

-size-mbs=<number> (optional)

Size of the VHD in number of MBs

-vhdx-sector-size=<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=<Parent VHD filename> (optional)

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

-label=<label text> (optional)

Label to assign to the new volume.

copy-profile

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=<VHD filename> (required)

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

-username=<user name> (required unless sid is specified)

‘username’ or ‘domain\username’

-sid=<sid string> (required unless username is specified)

Can be used instead of username to identify the profile

-size-mbs=<number> (optional)

Size of the VHD in number of MBs

-vhdx-sector-size=<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=<Parent VHD filename> (optional)

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

-profile-path=<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

create-junction

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.

 

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

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

 

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

Creates a new VHD(X) disk

 

-filename=<VHD filename> (required)

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

-size-mbs=<number> (optional)

Size of the VHD in number of MBs

-vhdx-sector-size=<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=<Parent VHD filename> (optional)

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

-label=<label text> (optional)

Label to assign to the new volume.

del-rule

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=<directory or key name> (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=<name> (optional)

<name> 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.

 

frx del-rule -src-parent="C:\users\admin\desktop" -src="chrome.lnk"
frx del-rule -src-parent="C:\windows" -src="bad.ini"
edit-profile

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=<VHD filename> (required)

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

enable-shnot
Enables shell refresh notification.
export-profilecfg

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.

 

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

Displays the main help screen:

frx help

 

Display help for a specific command.
frx help <command>
frx help add-rule
import-profilecfg

Import profile configuration settings from a file.

 

-filename (required)

The full path to the profile configuration file.

 

frx import-profilecfg -filename C:\data.frxconfig
list-rules

Lists the currently active rules.

moveto-vhd

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

 

-filename=<VHD filename> (required)

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

-src=<source folder> (required)

Full path to source folder

-size-mbs=<number> (optional)

Size of the VHD in number of MBs

-vhdx-sector-size=<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=<Parent VHD filename> (optional)

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

-label=<label text> (optional)

Label to assign to the new volume.

 

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

Migrates the contents of an existing VHD(X) to a new Virtual Disk.

 

-src (required)

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

-dest (required)

Specifies the new VHD(X) filename.

-size-mbs=<number> (optional)

Size of the VHD in number of MBs

-vhdx-sector-size=<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

 

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

Registers a font in the system font table.

 

-filename (required)

Specifies the path to the font file.

 

frx regfont -filename C:\myfont.ttf
reload-rules
Instructs the driver (frxdrv.sys) to reload (unload and load) all rules.
report-assignment

Reports on the applicability and non-applicability of a Rule Set by analyzing the assignment file and Active Directory.

 

-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.

 

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

Validates and stores the specified product key.

 

-key=<key> (required)

 

frx set-key -key=FSLX-000001-826453-4968
set-profile-redir

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

 

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

Shows information about a junction point

 

-src (required)

Specifies the path to the junction point.

 

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

Removes a font from the system font table.

 

-filename (required)

Specifies the path to the font file.

 

frx unregfont -filename C:\WINDOWS\SYSTEM32\myfont.ttf
validate-key

Determines if the specified product key is a valid key or not. If no key is specified, information will be displayed about the currently installed key. If no key is specified and no key is installed, information about the amount of time remaining in the trial period will be displayed.

-key=<key> (optional)

version

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.

 


 

 

 

Recently Updated