configurationengine/doc/cli/export.rst
author terytkon
Thu, 11 Mar 2010 17:04:37 +0200
changeset 0 2e8eeb919028
child 3 e7e0ae78773e
permissions -rw-r--r--
Adding EPL version of configurationengine.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
ConE export action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
==================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
Running action export
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
Usage: cone export [options]
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
The export functionality exports configurations from the current project to a remote project. Default value for the current project is the currently working directory. A project can be either a folder or a CPF/ZIP file.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
Examples
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
--------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
**Export a configuration from folder to a zip file**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
    >cone export -c configuration_root.confml --remote=exported.zip
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
or use the option -p|--project to point to the configuration project root::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
    >cone export --project=configproject_root --remote=exported.zip -c configuration_root.confml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
**Export a configuration from a zip|cpf file to a folder**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
The different to the previous example is that the project parameters are turned otherway around. ::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
    >cone export --project exported.zip --remote=. -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
**Export a configuration from a webstorage (carbon) file to a folder**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
The Carbon functionality will be released in ConE 1.2 release and is not yet officially available. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
The usage is similar to the previous, but the carbon path is given as http://serverpath/extapi.::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
    >cone export --project http://carbonqa.nokia.com/extapi -r . -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
See the info action for getting a list of available configurations inside Carbon.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
**Export a configuration from a folder to webstorage (carbon)**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
    >cone export --remote http://carbonqa.nokia.com/extapi -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
Options list
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
  --version             show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
  -h, --help            show this help message and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
  --print-settings      Print all the default settings from the current
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
                        setting container.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
  --print-supported-impls
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
                        Print all supported ImplML XML namespaces and file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
                        extension.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
  -v LEVEL, --verbose=LEVEL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
                        Print error, warning and information on system out.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
                        Possible choices: Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
                        NONE (all)    0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
                        CRITICAL      1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
                        ERROR         2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
                        WARNING       3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
                        INFO          4
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
                        DEBUG         5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
  -c CONFIG, --configuration=CONFIG
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
                        defines the name of the configuration for the action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
  -p STORAGE, --project=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
                        defines the location of current project. Default is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
                        the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
  Export options:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
    The export functionality is meant to export configurations between
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
    current project (defined with -p) to an remote project (defined with
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
    -r). Default value for the current project is the currently working
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
    directory. A project can be either a folder or a cpf/zip file.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
    -r STORAGE, --remote=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
                        defines the location of remote storage. Default name
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
                        for remote storage is the source configuration name
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
    -a SET, --add=SET   Add a configuration layer to the given configuration
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
                        as last element.The add operation can be used several
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
                        times in a single command and it can create even an
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
                        empty layer.Example --add foo/root.confml --add bar
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
                        /root-confml.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    83
    --exclude-folders   Excludes empty folders from .cpf export