Changes between Version 2 and Version 3 of Usage/UserDocumentation


Ignore:
Timestamp:
05/29/12 16:21:27 (12 years ago)
Author:
sil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Usage/UserDocumentation

    v2 v3  
    1616== About the CMT data(structure) ==
    1717
    18 
     18...
    1919
    2020= Web-interface =
    2121
    22 The web-interface can be opened in any regular web-browser. Ask your administrator for its address. Once you open the web-interface, a login page should appear where you have to issue your credentials.
     22The web-interface can be opened in any regular web-browser. Ask your administrator for its address. Once you open the web-interface, a login-page should appear where you have to issue your credentials.
    2323
    24 From there you'll be able to add objects to the database, lookup or change objects in the database, or delete objects from the database. It should be pretty intuitive to use. The most important entities you can act on are:
     24From there you'll be able to add objects to the database, explore objects in the database, change objects in the database, or delete objects from the database. It's meant as a intuitive easy-to-use interface, with advanced Create-Read-Update-Delete (CRUD) functionalities. It makes you able to quickly explore the data stored in CMT, or act on the data. The most important entities you can act on are:
    2525 Clusters::
    2626   A cluster could be described as a collection of hardware, connected to each other through one or more networks.
    … …  
    3737
    3838= Command Line Interface =
     39
     40To use the Command Line Interface has to be installed on your system. If you issue the command `cmt` you'll get the usage info:
     41{{{
     42Usage: cmt [options]
     43
     44This is the commandline interface of the SARA package SARA CMT.
     45
     46Options:
     47  -h, --help            show this help message and exit
     48  -n, --dry-run         This flag has to be given before -[aclmr]
     49  --script             
     50  -a ENTITY, --add=ENTITY
     51                        Add an object of given ENTITY.              arguments:
     52                        set <ASSIGNMENTS>              The object will get
     53                        values according to the given assignments.
     54                        Assignments could be formed like
     55                        [<FK>__]<attr>=<value>
     56  -c ENTITY, --change=ENTITY
     57                        Change value(s) of object(s) of given ENTITY.
     58                        arguments:   get <QUERY> set <ASSIGNMENTS>
     59                        The query, which consists out of one or more terms, is
     60                        used to make             a selection of objects to
     61                        change. These objects will be changed
     62                        according to the given assignments.
     63  -g TEMPLATE, --generate=TEMPLATE
     64                        Render the given template
     65  -l ENTITY [ATTRIBUTE=VALUE], --list=ENTITY [ATTRIBUTE=VALUE]
     66                        List object(s) of the given ENTITY.
     67                        arguments:   get <QUERY>              The query, which
     68                        consists out of one or more terms, is used to make
     69                        a selection of objects to list.
     70  -r ENTITY [ATTRIBUTE=VALUE], --remove=ENTITY [ATTRIBUTE=VALUE]
     71                        Remove objects which reflect the given query
     72  -v, --verbose         
     73}}}
     74
     75
    3976== Add object(s): `-a, --add` ==
    4077=== Syntax ===