configurationengine/doc/cli/fix.rst
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     1
ConE fix action
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     2
================
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     3
Running action fix
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     4
Usage: cone fix [options]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     5
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     6
The fix functionality is meant for running possible automatic fixes to problems which validation reports.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     7
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     8
Examples
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
     9
--------
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    10
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    11
**Fix a configuration**::
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    12
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    13
    >cd configproject_root
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    14
    >cone fix -c configuration_root.confml
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    15
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    16
or use the option -p|--project to point to the configuration project root::
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    17
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    18
    >cone fix --project=configproject_root -c configuration_root.confml
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    19
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    20
**Print a list of available fix classes**::
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    21
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    22
    >cone fix --print-available-fixes
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    23
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    24
    Running action fix
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    25
    Available fixers:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    26
    <class 'cone.validation.builtinvalidators.confml.DuplicateFeatureFixer'>:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    27
        A Fix class for duplicate features that merges all setting under a duplicate feature
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    28
        to the first instance of the feature and removes the duplicates.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    29
        
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    30
Options list
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    31
------------
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    32
  --version             show program's version number and exit
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    33
  -h, --help            show this help message and exit
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    34
  --print-settings      Print all the default settings from the current
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    35
                        setting container.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    36
  --print-supported-impls
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    37
                        Print all supported ImplML XML namespaces and file
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    38
                        extensions.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    39
  --print-runtime-info  Print runtime information about ConE.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    40
  -v LEVEL, --verbose=LEVEL
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    41
                        Print error, warning and information on system out.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    42
                        Possible choices: Default is 3.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    43
                        NONE (all)    0
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    44
                        CRITICAL      1
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    45
                        ERROR         2
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    46
                        WARNING       3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    47
                        INFO          4
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    48
                        DEBUG         5
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    49
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    50
  --log-config=FILE     Location of the used logging configuration file.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    51
                        Default is 'logging.ini'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    52
  --username=USERNAME   Username for webstorage operations. Not needed for
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    53
                        filestorage or cpf storage. If the username
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    54
                        is not given, the tool will use the logged in
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    55
                        username. Example: cone export -p webstorage_url -r .
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    56
                        -c sample.confml --username=admin --password=abc123.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    57
  --password=PASSWORD   Password for webstorage operations. Not needed for
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    58
                        filestorage or cpf storage. If the password
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    59
                        is not given, the tool will prompt for password if
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    60
                        needed.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    61
  -c CONFIG, --configuration=CONFIG
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    62
                        Defines the name of the configuration for the action
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    63
  -p STORAGE, --project=STORAGE
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    64
                        defines the location of current project. Default is
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    65
                        the current working directory.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    66
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    67
  Fix options:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    68
    The fix action is intended for performing fixes on a
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    69
    configuration.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    70
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    71
    --print-available-fixes
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    72
                        Print all configuration fixer objects available.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    73
    --exclude-filter=EXCLUDE_FILTER
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    74
                        Exclude problems by given filter. Examples: --exclude-
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    75
                        filter=schema, --exclude-filter=schema.implml,
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    76
                        --exclude-filter=schema.confml, --exclude-
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    77
                        filter=schema.implml.ruleml
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    78
    --include-filter=INCLUDE_FILTER
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    79
                        Include problems by given filter.Examples: --include-
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    80
                        filter=schema.implml, --include-
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents:
diff changeset
    81
                        filter=schema.implml.ruleml