VISULOX Command

CODE

visulox <command> [<command-specific args>]

During installation /usr/sbin/visulox is created, which makes it possible to execute the VISULOX Service Command without using the whole path.

Available parameters

Command	Description	Additional commands / args
addon	Command Line Interface to VISULOX Addons	cmdconnect, cmdguard, ftclient, host, script, template
admin	Manage the VISULOX Administration	cockpit, action, message, region, timeprofile
archive	Manage VISULOX Archive Node	-node <>, -set
assignments	Check assignments in policies and applications	app, datastore, policy
attach	Attach a node to the VISULOX Cluster	<hostname>, -location, -zone
cluster	Builds a VISULOX Cluster	data, layout, build -f <> \| -template
cockpit	Start of the VISULOX Cockpit	title <>, lang <>, roles <>, grant <>, groupaccess <>,owner <>, ksr, cdm, kiosk, personal
config	Manage the VISULOX configuration	accesspoint, datasources, dump, edit, env, list, locations,logo, mynodename, rebuild, reset, vap
database	Query the VISULOX Database	list, backup, restore, fields, query, integrity, status -vacuum, rename <>, node <>, table <>, timeout <>
datasource	Manage the VISULOX Datasources	add, check, copy, delete, edit, list
detach	Detach a node from the VISULOX Cluster	server <>, timeout <>
end2end	VISULOX end2end check	off, on, status
etcd	Manage ETCD instances	benchmark, client, del, get, instance, member, node, put, test
export	Export from VISULOX	events, files, sessions
integrity	VISULOX Integrity-Check	sys, lib, cmd, users, portal, ulimit, store, recorder, datasources, license
license	Manage the VISULOX License	list, replace, test, usage (-component <users\|sessions\|recorders\|hostcontrols> -unit <week\|month\|year>)
log	Query VISULOX log database	since <>, until <>, loglevel <>, follow
online	VISULOX online status	getpin, fields (list available fields), -i (ignore case), -object <> (owner or group mask), -application <>, -fields <>, sortby <> (sort by field)
otp	Manage the VISULOX OTP configuration	check <>, key, reset <>, set <>
passcache	Manage the VISULOX Passcache	list, fields, edit, delete
ping	Ping local master or designated worker	id <> (outdated)
policy	Command line interface to the VISULOX Policies	external, login, internal, access, application, transit
portal	Attach / detach VISULOX Service from VISULOX PORTAL Service (See also: VISULOX PORTAL ATTACH Command)	array, config, discover, drop, admin, mode, etc (see: VISULOX-PORTAL Command) visulox portal --help shows all available VISULOX PORTAL and VISULOX commands. With visulox portal admin -user <unixuser> a Unix user can be activated as VISULOX Portal Admin ( It is recommended to set a different user than root!)
pwdmgmt	Manage / list account passwords	expired, mustchange, notify <>, warn
report	Command line interface to VISULOX Report	title <>, mctitle <>, name <>, type <>, xslt <>, metadata <>, query <>, tframe <>, -from<>. -to <>, sql <>, lang <>, filename <>, mailto <>, mailsubject <>, maildescription <>, maildescriptionfile <>, archive <>
reset	Reset local cluster state
restart	Restart VISULOX Service (locally) Use with caution, all sg, sc and scx will be stopped.	-service <>, -timeout <>
start	Start VISULOX Service (locally)	debug
status	Query VISULOX status	diskfree, features, load, monitor, next, servers, services, sessions, uptime, usage, users, workers, server <>, serverfilter <>, print, fields <>
stop	Stop VISULOX Service (locally)	id <>
store	Manage the VISULOX store	attach, changed, detach, disable, enable, extras, get, migrate, missing, next, put, status, slot <>
support	Gather information for support (-info: short report)	directory <>, sys, dump, etc, rt, logs, net, integrity, config, tta
transit	Command line interface to VISULOX Transit Zone (list, import)	list, import, owner, path, rtime
version	Display versions of installed VISULOX packages

With -help or -? the detailed options for a basic command can be displayed.

If more parameters are needed for a command, the available options are always displayed by entering the basic command.

General commands

Parameter	Description
-format <value>	Format of output (text,xml,csv,json,tcl) / Default: <text>
-log <value>	Set loglevel to error, verbose, info or debug / Default: <>
-verbose	More messages on stdout
-run	Run an operation (use only on application request)
-stdin	Get arguments from stdin
--	Forcibly stop option processing
-help / -?	Display commands

Usage

The following examples show the usage of the VISULOX Service Command:

Show VISULOX status

CODE

visulox status

Show license information

CODE

visulox license

Replace license

CODE

visulox license replace -file <path to license file>

List sessions

CODE

visulox status sessions
visulox online

List unassigned applications

CODE

visulox database query -sql "select vlxapplication from external_applications WHERE vlxapplicationgroups = '' AND vlxapplicationusers = ''" -format csv -raw

Transit import & list

CODE

visulox transit import -path /tmp/file.txt  -owner "o=Tarantella System Objects/cn=TestUser"
visulox transit list  -owner "o=Tarantella System Objects/cn=TestUser"

Detach VISULOX Node

CODE

visulox detach <vlx-node.domain>