VISULOX 5 Documentation
5.0.2 5.0.1
5.0.2 5.0.1

Visulox Command

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), -retries <>

policy

Command line interface to the Visulox Policies

external, login, internal, access, application, transit

portal

Attach / detach Visulox Service from Visulox Portal Service

array, config, discover, drop, admin, mode, etc

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
( warning 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 <>, retries <>, 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
visulox status
Show license information
visulox license
Replace license
visulox license replace -file <path to license file>
List sessions
visulox status sessions
visulox online
List unassigned applications
visulox database query -sql "select vlxapplication from external_applications WHERE vlxapplicationgroups = '' AND vlxapplicationusers = ''" -format csv -raw
Transit import & list
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
visulox detach <vlx-node.domain>