How to export information from VISULOX on the command line
OverviewVISULOX Command Line Interface allows to export information.
|
Usage
The data on the local node, in the cluster of the node or on the Archive Server can be exported.
The export is done in two steps:
- Find the data which fulfills the export criteria
- Export the data into the directory
Per default, the export command does step 1. Step 2 is enabled with the -run option.
Options:
| Parameter | Description |
|---|---|
| -directory <> | Directory for export. Default value: /tmp. |
| -exportid <> | Export ID of the data. Default value: std. |
| -object <> | Distinguished object of user or group. Object ID can be used as well! |
| -application <> | Export application (session only) |
| -starttime <> | Start time of session export. Default value: 0. |
| -endtime <> | End time of session export. Default value: now. |
| -mode <> | Mode: local, cluster or archive. Default value: cluster. |
| -grant <> | Set granted user in database record <> |
Each time can be one of the following: the Unix epoch integer value, an interpretable time string (http://www.tcl.tk/man/tcl8.6/TclCmd/clock.htm#M80) or time arithmetic (http://www.tcl.tk/man/tcl8.6/TclCmd/clock.htm#M22).
Be careful, when setting the -mode variable to "cluster", all matching data from all VISULOX servers will be copied to the server, where the command has been started.
Make sure, that enough free disk space is available on this node or NFS share is used. The export can also be done "local" on every single node itself.
Export of events has some more options for a better presentation:
| Parameter | Description |
|---|---|
| eventtypes | Present list of available events types |
| examples | Present some usage examples |
| fields | Present list of available events fields |
| keywords | Present list of available events keywords |
| -fields <> | Fields to present in the result. Default value: <vlxowner,vlxevent,vlxeventinfo> |
| -filters <> | Comma separated list of query filter <> |
| -orders <> | Comma separated list of fields to order <> |
Export of sessions also has more options:
| Parameter | Description |
|---|---|
-password <> | Password for the ZIP archive.
If the type is session and no password will be set, a password will be generated automatically.
|
| -sessionid <> | Session ID <> |
| -kbi | Include Keyboard Inputs |
Export criteria
Using exportid
Export filters can be set on objects (owner or groups) and applications. Also there is an exportid.
With the exportid it is possible to export only the data, which does not have that exportid already. After a successful run the exported data is marked with the exportid.
visulox export sessions -object cn=Group1 -directory /tmp/export -exportid "Group1" -run(The directory must be readable/writeable by the vlx user.)
To restart the export from the beginning with exportid use -force.
Wildcards
The object parameters are always used internally with the wildcard "*" at the beginning and at the end.Using starttime and endtime
export last week
visulox export sessions -object cn=Group1 -directory /tmp/export -starttime "-1 week" -endtime now -run