utilitário de linha de comando frx

Artigo
11/10/2023

frx é um utilitário de linha de comando que fornece gerenciamento e configuração de uma configuração FSLogix. O utilitário gerencia regras, perfis e contêineres, pesquisa, gerenciador de credenciais e outras funções diversas.

Comandos

Comando	Descrição
Ajuda?	Exibir esta mensagem de ajuda
version	Exibir as versões dos componentes carregados

Regras

Comando	Descrição
Adicionar-redirecionar	Adicionar um novo redirecionamento de pasta
Regra de adição	Adicionar a regra especificada
create-conjunto de regras	Cria um conjunto de regras
del-redirecionamento	Excluir um redirecionamento de pasta ativa
del-regra	Excluir a regra especificada
redirecionamentos de lista	Listar redirecionamentos de pasta ativos no momento
lista-regras	Listar regras carregadas no momento
regras de recarga	Recarregar regras do cache

Perfis e contêineres virtuais

Comando	Descrição
copiar perfil	Copiar o perfil de um usuário para um VHD ou VHDX
CopyTo-VHD	Copiar uma pasta e seu conteúdo para um VHD ou VHDX
criar-vhd	Criar e formatar um VHD ou VHDX
editar perfil	Editar conteúdo de perfil contido em um VHD ou VHDX
begin-edit-profile	Anexa o VHD ou VHDX especificado e o hive do Registro
end-edit-profile	Desanexa o VHD ou VHDX especificado e o hive do Registro
export-profilecfg	Exportar definições de configuração de perfil para arquivo
import-profilecfg	Importar definições de configuração de perfil do arquivo
migrar-vhd	Migra o conteúdo de um VHD existente para um novo
Moveto-VHD	Mover uma pasta e seu conteúdo para um VHD ou VHDX
set-perfil-redir	Define a configuração de redirecionamentos de pasta do perfil

Componente de pesquisa

Comando	Descrição
reset-user-search-db	Reindexar o banco de dados de índice de pesquisa de um usuário.

Gerenciamento de chaves do Gerenciador de Credenciais

Comando	Descrição
add-secure-chave	Adicionar uma chave segura ao Gerenciador de Credenciais
del-secure-key	Excluir uma chave segura do Gerenciador de Credenciais
list-secure-key	listar as chaves contidas no Gerenciador de Credenciais

Diversos

Comando	Descrição
criar-junção	Cria um ponto de junção para um volume ou pasta de destino
habilitar-shnot	Habilita a notificação de atualização do shell
Regfont	Registra uma fonte na tabela de fontes do sistema
atribuição de relatórios	Relatório de aplicabilidade do conjunto de regras
mostrar-junção-info	Mostra informações sobre um ponto de junção
unregfont	Remove uma fonte da tabela de fontes do sistema
agente inicial	Inicia todos os drivers e serviços que compõem o agente
agente de parada	Para todos os motoristas e serviços que compõem o agente

Versão FRX

Exibe as versões dos componentes carregados

Exemplos

    frx version

Regras

FRX add-redirect

Adicionar um novo redirecionamento de caminho para o driver de virtualização

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

Parâmetros obrigatórios

-source ou -src

Especifica o caminho de origem a ser redirecionado.

-destination ou -dest

Especifica o caminho para atuar como destino de redirecionamento.

Exemplos

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

frx add-rule

Adicione uma regra específica.

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

Exemplos

    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

Parâmetros obrigatórios

-src-parent

Diretório/chave pai ou impressora à qual a regra se aplica.

Parâmetros Opcionais

-src

Nome do arquivo ou do valor

-dest-parent

Diretório ou chave de destino (somente regras de redirecionamento).

-dest

Arquivo ou valor de destino (somente regras de redirecionamento).

-no-copy

Cria uma cópia em branco do item no redirecionamento, se ele não existir (o padrão é copiar o item de origem).

-volatile

Regra volátil que não persistirá em uma reinicialização da máquina.

-datatype

Tipo de dados específicos a serem retornados (SZ, DWORD).

-data

Representação hexadecimal dos dados a serem retornados.

Variáveis Especiais

Utilizável em -dest-parent ou -dest parâmetros.

Variável	Descrição
`__USER_SID__`	SID do usuário
`__USER_NAME__`	Nome de usuário do usuário
`__USER_PROFILE_PATH__`	Caminho para o perfil dos usuários

frx create-ruleset

Cria um conjunto de regras examinando o diretório de instalação especificado.

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

Exemplos

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

Parâmetros

-filename

Especifica o nome do arquivo a ser criado.

-install-dir

Especifica o caminho de instalação do aplicativo a ser examinado.

-ARP-keyname

Especifica o local do Registro Adicionar ou Remover programa.

frx del-redirecionamento

Exclui um redirecionamento ativo.

    frx del-redirect -source <path>

Exemplos

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

Parâmetros

-source

Especifica a pasta de origem da qual remover o redirecionamento.

frx del-rule

Exclua a regra especificada.

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

Exemplos

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

Parâmetros obrigatórios

-src-parent

Diretório pai ou chave à qual a regra se aplica.

Parâmetros Opcionais

-src

Nome do arquivo ou valor.

redirecionamentos de lista frx

Lista os redirecionamentos de pasta ativa atuais.

    frx list-redirects

regras de lista frx

Lista todas as regras carregadas no sistema.

    frx list-rules -verbose

Parâmetros Opcionais

-verbose

Exibe informações adicionais sobre a regra.

regras de recarga de frx

Recarrega as regras. Pode ser específico para um arquivo de regras ou aplicar a todas as regras.

Observação

As regras de recarregamento não afetam as regras voláteis.

    frx reload-rules -filename <path>

Exemplos

    frx reload-rules -filename Rules.fxr

Parâmetros Opcionais

-filename

Especifica o arquivo de regras a ser recarregado.

Perfis e Contêineres Virtuais

FRX Copy-Profile

Aviso

Se o tamanho do perfil local exceder 5 GB, você deverá especificar o -size-mbs parâmetro com um tamanho maior que 5000.

Copie o perfil de um usuário para um VHD ou VHDX. Se o arquivo VHD ou VHDX não existir, ele será criado.

    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>

Exemplos

Perfil local inferior a 5 GB

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

Perfil local maior que 5 GB

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo VHD(x).

-username

Especificado como Nome de Usuário ou DOMÍNIO\Nome de Usuário

-sid

Usado no lugar de -username para identificar o perfil.

Parâmetros Opcionais

-size-mbs

Tamanho em número de MBs para novos VHD/VHDX

-vhdx-sector-size

Tamanho do setor VHDX

-dynamic

Definir como 1 para dinâmico, 0 para disco fixo

-src-parent

Caminho do arquivo VHDX pai para discos diferenciais

-verbose

Habilita a saída detalhada

-profile-path

Especificar o caminho do perfil

-label

Rótulo do volume do disco (o padrão é Perfil)

-redirections

Especifique o arquivo de redirecionamentos a ser copiado para o perfil

FRX Copyto-VHD

Copiar uma pasta e seu conteúdo para um VHD ou 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>

Exemplos

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo VHDX

-src

Especifica a pasta de origem a ser copiada

Parâmetros Opcionais

-dest

Especifica a pasta de destino no arquivo VHDX. O destino padrão é a pasta raiz VHDX.

-size-mbs

Tamanho em número de MBs para novos VHD/VHDX

-vhdx-sector-size

Tamanho do setor VHDX

-dynamic

Definir como 1 para dinâmico, 0 para disco fixo

-verbose

Habilita a saída detalhada

-label

Rótulo do volume do disco (o padrão é Perfil)

FRX Create-VHD

Crie e formate um VHD ou VHDX. Por padrão, o VHD ou VHDX terá 30 GBs e será dimensionado dinamicamente.

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

Exemplos

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo VHDX

Parâmetros Opcionais

-size-mbs

Tamanho em número de MBs para novos VHD/VHDX

-vhdx-sector-size

Tamanho do setor VHDX

-dynamic

Definir como 1 para dinâmico, 0 para disco fixo

-src-parent

Caminho do arquivo VHDX pai para discos diferenciais

-label

Rótulo do volume do disco (o padrão é Perfil)

frx edit-perfil

Anexa o VHD ou VHDX especificado e abre uma janela do Explorer e um editor do Registro para que o conteúdo do perfil possa ser exibido e editado.

    frx edit-profile -filename <path>

Exemplos

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

Parâmetros

-filename

Especifica o caminho para o arquivo VHDX

frx begin-edit-profile

Anexa o VHD ou VHDX especificado e anexa o hive do Registro para que o conteúdo do perfil possa ser visualizado e editado.

    frx begin-edit-profile -filename <path>

Exemplos

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

Parâmetros

-filename

Especifica o caminho para o arquivo VHDX

FRX end-edit-profile

Desanexa o VHD ou VHDX especificado e o hive do Registro

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

Exemplos

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

Parâmetros

-cookie

Especifica o cookie impresso a partir da chamada start-edit-profile.

-filename

Especifica o caminho para o arquivo VHDX

FRX Export-ProfileCFG

Exporta definições de configuração de perfil e associação de grupo de inclusão/exclusão para um arquivo. As configurações podem ser importadas posteriormente com o comando import-profilecfg.

    frx export-profilecfg -filename <path>

Exemplos

    frx export-profilecfg -filename my_configuration.frxconfig

Parâmetros

-filename

Especifica o arquivo para os dados de configuração a serem armazenados.

frx import-profilecfg

Importa definições de configuração de perfil e associação de grupo de inclusão/exclusão do arquivo. Esse arquivo pode ser gerado com o comando export-profilecfg.

    frx import-profilecfg -filename <path>

Exemplos

    frx import-profilecfg -filename my_configuration.frxconfig

Parâmetros

-filename

Especifica o arquivo para os dados de configuração a serem armazenados.

FRX Migrate-VHD

Cria, formata um VHD ou VHDX e espelha o conteúdo do VHD de origem. Por padrão, o VHD ou VHDX terá 30 GBs e será dimensionado dinamicamente.

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

Exemplos

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

Parâmetros obrigatórios

-src

Especifica o caminho para o arquivo VHDX de origem

-dest

Especifica o novo nome de arquivo VHDX.

Parâmetros Opcionais

-size-mbs

Tamanho em número de MBs para novos VHD/VHDX

-vhdx-sector-size

Tamanho do setor VHDX

-dynamic

Definir como 1 para dinâmico, 0 para disco fixo

FRX Moveto-VHD

Move uma pasta junto com todas as suas subpastas e arquivos para um disco 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>

Exemplos

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo VHDX

-src

Especifica a pasta de origem a ser movida

Parâmetros Opcionais

-dest

Especifica a pasta de destino no arquivo VHDX. O destino padrão é a pasta raiz VHDX.

-size-mbs

Tamanho em número de MBs para novos VHD/VHDX

-vhdx-sector-size

Tamanho do setor VHDX

-dynamic

Definir como 1 para dinâmico, 0 para disco fixo

-verbose

Habilita a saída detalhada

-label

Rótulo do volume do disco (o padrão é Perfil)

frx set-profile-redir

Define a configuração de redirecionamentos de pasta do perfil

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

Exemplos

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo VHDX

Parâmetros Opcionais

-redirections

Especifique o arquivo de redirecionamentos a ser copiado para o perfil.

-no-redirections

Remova todos os redirecionamentos que estão saindo do perfil.

Componente de pesquisa

frx reset-user-search-db

Reindexar o banco de dados de índice de pesquisa de um usuário.

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

Exemplos

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

Parâmetros

-username

Especifique username ou DOMAIN\username.

-sid

Especifique o SID dos usuários em vez de usar -username

Gerenciamento de chaves do Gerenciador de Credenciais

frx add-secure-key

Adicione uma chave segura ao Gerenciador de Credenciais.

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

Exemplos

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

Parâmetros

-key

Especifica o nome da chave para a credencial.

-value

Especifica o valor da chave desejada.

frx del-secure-key

Excluir uma chave segura do Gerenciador de Credenciais

    frx del-secure-key -key <string>

Exemplos

    frx del-secure-key -key fslogix

Parâmetros

-key

Especifica o nome da chave para a credencial.

frx lista-secure-key

Listar as chaves contidas no Gerenciador de Credenciais

    frx list-secure-key

Diversos

frx create-junction

Cria um ponto de junção para um volume ou pasta de destino

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

Exemplos

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

Parâmetros obrigatórios

-src

Especifica a unidade ou pasta onde o ponto de junção será adicionado.

-dest

Especifica a pasta ou o volume de destino.

Parâmetros Opcionais

-name

Nome de exibição opcional.

frx enable-shnot

Habilita a notificação de atualização do shell

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

Exemplos

    frx enable-shnot -force

Parâmetros Opcionais

-true

Habilita notificações

-false

Desativa notificações

-force

Força a notificação imediata se habilitado.

frx regfont |

Registra uma fonte na tabela de fontes do sistema

    frx regfont -filename <path>

Exemplos

    frx regfont -filename C:\myfont.ttf

Parâmetros

-filename

Especifica o caminho para o arquivo de fonte.

Atribuição de relatórios FRX

Relata a aplicabilidade e a não aplicabilidade de um Conjunto de Regras analisando o arquivo de atribuição e o Active Directory.

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

Exemplos

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

Parâmetros obrigatórios

-filename

Especifica o caminho para o arquivo de atribuição.

Parâmetros Opcionais

-username

Relata a aplicabilidade do arquivo de atribuição para o usuário especificado (nome distinto).

-verbose

Habilita a saída detalhada.

-csv

Habilita a saída no formato de valor separado por vírgula (CSV).

frx show-junction-info

Mostra informações de ponto de junção na pasta especificada.

    frx show-junction-info -src <path>

Exemplos

    frx show-junction-info -src E:\

Parâmetros

-src

Especifica de qual unidade ou pasta as informações são coletadas.

frx unregfont

Remove uma fonte da tabela de fontes do sistema

    frx unregfont -filename <path>

Exemplos

    frx unregfont -filename C:\myfont.ttf

Parâmetros

-filename

Especifica o caminho para o arquivo de fonte.

FRX Agente de Início

Inicia todos os drivers e serviços que compõem o agente

    frx start-agent

FRX Stop-Agent

Para todos os motoristas e serviços que compõem o agente

    frx stop-agent

Share via

utilitário de linha de comando frx

Comandos

Regras

Perfis e contêineres virtuais

Componente de pesquisa

Gerenciamento de chaves do Gerenciador de Credenciais

Diversos

Versão FRX

Exemplos

Regras

FRX add-redirect

Parâmetros obrigatórios

Exemplos

frx add-rule

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

Variáveis Especiais

frx create-ruleset

Exemplos

Parâmetros

frx del-redirecionamento

Exemplos

Parâmetros

frx del-rule

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

redirecionamentos de lista frx

regras de lista frx

Parâmetros Opcionais

regras de recarga de frx

Exemplos

Parâmetros Opcionais

Perfis e Contêineres Virtuais

FRX Copy-Profile

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

FRX Copyto-VHD

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

FRX Create-VHD

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

frx edit-perfil

Exemplos

Parâmetros

frx begin-edit-profile

Exemplos

Parâmetros

FRX end-edit-profile

Exemplos

Parâmetros

FRX Export-ProfileCFG

Exemplos

Parâmetros

frx import-profilecfg

Exemplos

Parâmetros

FRX Migrate-VHD

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

FRX Moveto-VHD

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

frx set-profile-redir

Exemplos

Parâmetros obrigatórios

Parâmetros Opcionais

Componente de pesquisa

frx reset-user-search-db

Exemplos

Parâmetros

Gerenciamento de chaves do Gerenciador de Credenciais