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