Overview
VISULOX has an internal table with many configuration parameters like:
|
Types
There are three types of parameters:
-
FIXED: Cannot be be changed
-
SETUP: Can be changed on setup of a node
-
OPERATION: Can be changed at any time
Parameters can be listed, changed and reset to their default values with the "VISULOX config" command.
If a parameter is changed or reset it will be replicated to other nodes.
Configuration parameters set while the node is offline will only be applied to the local node.
If a parameter should be changed for the whole cluster, the parameter has to be set again once the node is online again.
Changing can be done on any node. Last change will win.
Only parameters of the type SETUP and OPERATION can be changed.
Usage
visulox config -name <mask of parameter>
visulox config -name basicname
visulox config -name layout
The changed parameters can be shown with:
visulox config list -changed
With the following command the changed settings can be exported into an import script to import them on another environment:
visulox config export
Long values are truncated. This can be seen if "..." is presented. To get the whole value use -raw.
------------------------------------------------------------------------------------------------------------------
| parameter | type | value ... |
------------------------------------------------------------------------------------------------------------------
| x11.windownames | FIXED | Toolbar scx.tcl VLXTASKBAR metacity dtwm "TWM Icon Manager" gnome-settin ... |
------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------
| parameter | type | value |
--------------------------------------------------------------------------------------------------------------------------------
| x11.windownames | FIXED | Toolbar scx.tcl VLXTASKBAR metacity dtwm "TWM Icon Manager" gnome-settings-daemon mwm FVWM |
--------------------------------------------------------------------------------------------------------------------------------
A config parameter can be modified with "=" and the new value, that should be set. A validation of the value is done. The internal configuration files are written.
visulox config -name guidefaults.access_policy.basicname=MYVALUE
Multiple parameters and multiple values can be modified in one statement:
visulox config -name NAME1=VALUE1:VALUE2,NAME2=VALUE1:VALUE2,NAME3=VALUE1:VALUE2
If a VALUE is a list, the separator is ":":
visulox config -name NAME="a:b:c"
If a value contains a comma, which is used as separator, "\\" must be used:
visulox config -name regexp.email="[0-9]{2\\,5}"
A modified config parameter can be reset to his default parameter:
visulox config reset -name guidefaults.access_policy.basicname
This command rebuilds the local configuration. Under normal operation this command is not needed:
visulox config rebuild
visulox <command> | less -S
Common parameters
The basic admin command and subcommands have common command line options:
|
Command |
Parameter |
Description |
|---|---|---|
|
-format |
text |
Default. Displays the output in a human readable format. |
|
|
csv |
Output is listed in the format of comma separated values. The CSV delimiter is ";". |
|
|
json |
Output is listed in the format of JSON. |
|
|
tcl |
Output is listed in the format of a TCL array format. |
|
|
cli:var1:var2 |
Output is listed in the format of comma separated values of the vars listed. The delimiter is ";". Use full for further command execution |
|
-force |
|
Some commands will not run because the impact is big. With -force the command operates without comment.
|
|
-run |
|
Some commands are in a dry mode and will be enabled with -run. |
|
-stdin |
|
This allows to pipe all parameters via stdin into the command. |
|
-log |
error,verbose,info,debug |
Overrides the log level. |
|
-verbose |
|
Command is more chatty. |
|
-raw |
|
Information is not formated. (unix time stamps, full user names, etc) |
Usage of the -stdin command:
echo "-endpoint foo1@server" | visulox addon host add -stdin
Spaces via -stdin are not allowed. If a comment with spaces should be entered, here is a possibility:
echo "-name foo -endpoint foo3@server -comment64 $(echo this is the comment) " | visulox addon host add -stdin
Entering passwords via command line
For all configuration commands, where entering a password is necessary ((e.g. -password, adminpwd, ...), the password can be entered hidden after typing "-" in the console.
Base64 decode parameter
It is possible to provide any parameter in a base64 declaration. This is useful if spaces, newlines or other critical parameters have to be provided. Base64 Paramaters have the prefix 64 and is very good to use it togeter with standard in.
Characters must be in UTF-8 format.
echo "-name64 dGVzdC1iYXRzLTU= -object64 bz1UYXJhbnRlbGxhIFN5c3RlbSBPYmplY3RzL2NuPUFkbWluaXN0cmF0b3I= -ticket64 QS0xMg== -endtime64 ZW5kbGVzcw==" | visulox policy access add -stdin
Useful (%NODE% variable)
The following commands allow the %NODE% variable, which will be substituted with the local logical nodename:
visulox config -name "... %NODE%"
./database.tcl query -sql "... %NODE%"
Further command procession
The formated output is not helpful for "grep", "awk", "sed" etc.
Therefore use "-format cli:var1,var2" or "-format cli:var1,var2 -raw"
visulox status users -format cli:vlxowner:webtopsessionid -raw | grep Admin
Ambigous values in commands
|
Expression |
Description |
|---|---|
|
*<value>* |
Will always be used as a mask |
|
<value>*<value> |
Will be used to find an unambiguous object |
|
-verbose |
if object is ambiguous -verbose lists the first 10 elements which are found |
This applies to the policy parameters -application, -object, -dcobject.
Known issues and comments
Changing of the configuration (sometimes) needs a restart of VISULOX.
On some commands the output per line is too long and so it will not be readable. Helpful is "-format json".
Related information
How to change the VISULOX logos and colors
How to work with VISULOX Datasources
Setting the min/max length for messages, contents and comments