CLI Commands for FlexRule Server Configuration

◷ Reading Time: 10 minutes

Running the CLI commands requires FlexRule Server installation. Once you have installed the server,

1. Run Command Prompt as administrator and navigate to the Identity folder.
   cd <Identity folder location>
2. Run the configuration commands.

To run any configuration command requires a config file in the server installation location.

Therefore, you must first run the new config file command to create a file if there is no config file and then run the other configuration commands.

New config file

Create a new configuration file for FlexRule Server.

 FRS.exe config --new [executionWorker | executionController | assetManagement | workbench | studio] --force

• –new: The node that you want to update
• –force: Optional: overwrites an existing config file

Examples

Controller:

FRS.exe config --new executionController --force

Worker:

FRS.exe config --new executionWorker

API Address

Set the address for the Server node.

 FRS.exe config --[executionWorker | executionController | assetManagement | workbench | studio] --host IP:PORT

• –executionWorker | executionController | assetManagement | workbench | studio: The node that you want to update
• host: The IP and the port of the address you want to set as the node address. This address must specify the protocol (http:// or https://)

Example

Execution Controller:

FRS.exe config --executionController --host http://localhost:9001

Execution Worker:

FRS.exe config --executionWorker --host http://localhost:9002

Setting node addresses

You can set the required node addresses for each Server node in the configuration for Worker / Controller / Asset Management / Workbench / Studio.

FRS.exe config --[executionWorker | executionController | assetManagement | workbench | studio] --<node>Address IP:PORT

• –[executionWorker | executionController | assetManagement | workbench | studio]: This is a mandatory command, setting the node to config.
• –<node>Address: The IP and the port of the node address. This address must specify the protocol (http:// or https://).
  You can find this value from the node’s configuration file (FlexRule.OPEN.<node>.dll.config), under the tag ApiAddress.

Example

Worker:

 FRS.exe config --executionWorker --identityAddress "http://localhost:9000"
FRS.exe config --executionWorker --assetManagementAddress "http://localhost:9004"

Workbench

Set the workbench address. This is only for the Workbench node

FRS.exe config --workbench [true|false] --host IP:PORT

• –workbench: State whether you want to set a workbench (true/ false)
• –host: The IP and the port of the address you want to set as the node address. This address must specify the protocol (http:// or https://)

Examples

FRS.exe config --workbench true --host "http://localhost:9010"

Error log file

Set error log file path.

FRS.exe config --<node> --error --file [log file path] --eventLog

• –<node>: The Server node you want to modify
• –error: This is a mandatory command.
• –file: Define the path including the file you want to write logs. You can define any file for this.
• –eventLog: Write to the windows system event log.

Example

FRS.exe config --identity --error --file "C:\Program Files (x86)\identity.log" --eventLog

Security keys

Set the security keys. All the keys should be 32 characters long.

encryptionPassword shared encryption password to secure communication between nodes.

sharedSecret and authSignKey of the nodes should be the same to allow the nodes to communicate with each other.

FRS.exe config --<node> --security [--encryptionPassword [encryptionValue]] [--sharedSecret [secretValue]] [--authSignKey [authValue]]

• –<node>: The Server node you want to modify
• –security: This is a mandatory command.
• –encryptionPassword: Encryption key
• –sharedSecret: Shareed secret
• –authSignKey: Authentication key

Example

FRS.exe config --identity --security --encryptionPassword "rtfeWvGee4t3UR3CE@km3RE8ey7rq87N" --sharedSecret "abcdWvGee4t3UR3CE@km3RE8ey7rq87N" --authSignKey "1234WvGee4t3UR3CE@km3RE8ey7rq87N"

Database

Database configuration

Set the database settings of the FlexRule Server. There should be only one database for all the nodes.

FRS.exe config --<node> --database --server [serverValue] --name [dbName]  --user [userValue] --password [passwordValue] --integrated --azure --encrypt --trustCert --timeout [timeoutValue] --port [portValue]

• –<node>: The Server node you want to modify
• –database: This is a mandatory command
• –server: Database server address
• –name: Database name
• –user: Username to connect to the database
• –password: Password to connect to the database
• –integrated: Option to use Windows Authentication (Integrated Security)
• –azure: Option to use MS SQL Azure database
• –encrypt: Option to state encryption
• –trustCert: State whether you have Trust Server Certificate
• –timeout: State timeout period
• –port: State the port

Example

FRS.exe config --identity --database --server "FLEXRULE-02\SQLEXPRESS02" --name "frdb9096" --user "testUser" --password "testPw" --encrypt --trustCert --timeout 30 --integrated --azure "test" --port 2500

Database migration

When there is an existing database, you can migrate the database.

FRS.exe database --migrate [refresh|new]

• –migrate: State whether you want to refresh or create new. Refresh deletes the data in the database while new creates a new version of the database

Example

FRS.exe database --migrate new

Create database

Create or update the database. This command does not have any user-defined arguments. It will use the database configuration you configured and create the database accordingly.

This will create the following default user and client accounts, along with the roles.

• Roles: Administrator and Application
• User: Admin
• Client: App1
• Default password: FlexRuleServer

The same command is used for all nodes.

FRS.exe database --create default

Example

FRS.exe database --create default

Client or User Accounts

Creates user or client accounts.

FRS.exe account --type [client|user] --name [name of account] --pw [VALUE]

• –type: The type of the account (user/ client)
• –name: Name of the account. This is the username or client account name
• –pw: password of the account

Example

FRS.exe account --type user --name "TestUser" --pw "O45&kd@darren"

FRS account --type user --name "admin2" --pw "123"

FRS account --type user --name "admin" --pw "123" --resetPassword

FRS account --type client --name "app1" --pw "123456" --resetpassword (to change client secret)

Azure AD sign-in

Add

FRS.exe config --<node> --sso "add" --azure --clientid <your client ID> --tenantId <Your tenant ID>

Update

FRS.exe config --<node> --sso "update" --azure --clientid <your client ID> --tenantId <Your tenant ID>

Remove

FRS.exe config --<node> --sso "remove" --azure

Migration

A detailed migration command list is explained in this article.

Run the migration

Use the following command with appropriate values for your instance:

frs migration --oldConfig "<old V8 config>" --server-license "<server.lic>" --runtime-license "<runtime.lic>" --runtime "<runtime folder or .nupkg>" --db "<new database connection string>"

Example

Suppose:

• old V8 config = C:\Program Files (x86)\Pliant Framework\FlexRule Server\8.3.14\Master\FlexRule.Server.Master.dll.config
• new database connection string = "Data Source=.\SQLEXPRESS;Initial Catalog=FRS 11.4.2983;Integrated Security=True
• Server license = C:\Licenses\server.lic
• Runtime license = C:\Licenses\runtime.lic
• Runtime folder = C:\Users\<user>\Documents\.nugets\FlexRule.Runtime.11.4.1818.nupkg

The command would be:

cd "C:\Program Files (x86)\FlexRule\Server\11.4.2983\Identity"
frs migration --oldConfig "C:\Program Files (x86)\Pliant Framework\FlexRule Server\8.3.14\Master\FlexRule.Server.Master.dll.config" --db "Data Source=.\SQLEXPRESS;Initial Catalog=FRS 11.4.2983;Integrated Security=True" --server-license "D:\FR License\2026\V11\flexrule.server.license-11.lic" --runtime-license "D:\FR License\2026\V11\flexrule.license-11.lic" --runtime "C:\Users\<user>\Documents\.nugets\FlexRule.Runtime.11.4.1818.nupkg"