Fix: sessiond: invalid session configuration on EXCLUDE_ALL policy

[deliverable/lttng-tools.git] / doc / man / lttng-load.1.txt

lttng-load(1)
=============
:revdate: 28 November 2016


NAME
----
lttng-load - Load LTTng tracing session configurations


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
      [option:--override-url='URL'] ['SESSION' [option:--override-name='NAME']]


DESCRIPTION
-----------
The `lttng load` command loads the configurations of one or more
tracing sessions from files.

The `lttng load` command is used in conjunction with the
man:lttng-save(1) command to save and restore the complete
configurations of tracing sessions. This includes the enabled channels
and event rules, the context added to channels, the tracing activity,
and more.

Once one or more tracing session configurations are loaded, they appear
exactly as they were saved from the user's point of view.

The following directories are searched, non-recursively, in this order
for configuration files:

. `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
. +{system_sessions_dir}+

The input path can be overridden with the option:--input-path option.
When this option is specified, the default directories are :not:
searched for configuration files. When it's not specified, _both_
default directories are searched for configuration files.

If the input path is a *directory*, then:

* If 'SESSION' is specified, the tracing session configuration named
  'SESSION' is searched for in all the files of this directory and
  loaded if found.
* If 'SESSION' is not specified, the option:--all option is implicit:
  all the tracing session configurations found in all the files in this
  directory are loaded.

If the input path is a *file*, then:

* If 'SESSION' is specified, the tracing session configuration named
  'SESSION' is searched for in this file and loaded if found.
* If 'SESSION' is not specified, the option:--all option is implicit:
  all the tracing session configurations found in this file are loaded.

Aspects of the loaded configurations can be overridden at load time
using the option:--override-url and option:--override-name options.

By default, existing tracing sessions are not overwritten when loading:
the command fails. The option:--force option can be used to allow this.


include::common-cmd-options-head.txt[]


option:-a, option:--all::
    Load all tracing session configurations (default).

option:-f, option:--force::
    Overwrite existing tracing sessions when loading.

option:-i 'PATH', option:--input-path='PATH'::
    Load tracing session configurations from 'PATH', either a directory
    or a file, instead of loading them from the default search
    directories.

option:--override-name='NAME'::
    Override the name of the loaded tracing session configuration,
    'SESSION', with 'NAME'.
+
You must specify a tracing session name to load ('SESSION') and :not:
use the option:--all option when using this option.

option:--override-url='URL'::
    Override the URL of the loaded tracing session configurations
    with 'URL'.
+
This is the equivalent of the nloption:--set-url option of
man:lttng-create(1). The validity of the URL override depends on the
type of tracing session configurations to load. This option applies to
_all_ the loaded tracing session configurations.


include::common-cmd-help-options.txt[]


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng-save(1),
man:lttng(1)