Changes between Version 4 and Version 5 of Usage/UserDocumentation

Timestamp:

06/01/12 15:24:03 (12 years ago)

Author:

sil

Comment:

documented some non-crud options of cmt client

Usage/UserDocumentation

@@ -78 +78 @@
 
 
-== Add object: `-a, --add` ==
+== CRUD options ==
+
+Just like the web-interface, the CLI can be used for CRUD-functionalities (Create, Read, Update, Delete) too. However, the implementation of the CLI is much more powerful, since it can be used to do things with multiple objects at once, and can be done from shell-scripts.
+
+=== Add object: `-a, --add` ===
 
 Use this option to add a new object of a given entity to the database. You have to specify the entity and assign values to its fields by providing assignments as extra arguments. The syntax is as follows:
@@ -86 +90 @@
 }}}
 
-=== Use case ===
+==== Use case ====
 
 '''You want to add a new server, and its interfaces'''
@@ -107 +111 @@
 }}}
 
-
-== Change object(s): `-c, --change` ==
+=== List object(s): `-l, --list` ===
+
+Use this option to list existing objects in the database. You have to specify the entity, and filter objects you want to list by providing a query. The syntax is as follows:
+
+{{{
+cmt_sara --list <entity> [get] <query>
+}}}
+
+==== Use case ====
+
+'''If you need to figure out where a machine -- in this case `test3` -- is physically hosted:'''
+
+When an engineer has to fix a node you need to tell him the location of the node. This information shall be listed by issuing the following command:
+
+{{{
+user@host$ cmt --list hardwareunit label=test3
+}}}
+
+The output of this command looks like:
+
+{{{
+ .---[  test3  ]---
+ : cluster        : LDAP/CUA
+ : address        : Amsterdam - Science Park 121
+ : room           : S142A
+ : rack           : rack AD38
+ : first_slot     : 23
+ : specifications : PowerEdge 1950 (Dell bv)
+ : roles          : administration
+ : in_support     : True
+ '---
+}}}
+
+=== Change object(s): `-c, --change` ===
 
 Use this option to change fields of one or more objects in the database. You have to specify the entity, filter objects you want to change by providing a query, and assign new values to their fields by providing assignments as extra arguments. The syntax is as follows:
@@ -116 +152 @@
 }}}
 
-=== Use case ===
+==== Use case ====
 '''You have to change an existing address:'''
 
@@ -177 +213 @@
 }}}
 
-
-== Generate a config-file: `-g, --generate` ==
+=== Remove object(s): `-r, --remove` ===
+
+Use this option to remove objects from the database. You have to specify the entity, and filter objects you want to remove by providing a query. The syntax is as follows:
+
+{{{
+sara_cmt --remove <entity> [get] <query>
+}}}
+
+==== Use case ====
+
+'''You have removed a server from a rack:'''
+
+For example the first node in rack 2:
+
+{{{
+user@host$ cmt --remove hardwareunit rack=2 first_slot=1
+INFO     remove 233 :: Found 1 objects matching query: r2n1
+Are you sure? [Yn]
+}}}
+
+As you can see there will be asked for confirmation by default.
+
+
+== Other options ==
+
+=== Dry-run: `-n, --dry-run ===
+
+Use this option to suppress (CRUD-)actions that make changes to the database. Please note, this option has to be given ''before'' CRUD-options. So, use it like:
+
+{{{
+user@host$ cmt --dry-run --{add,list,change,remove} ENTITY ...
+}}}
+
+This option can become handy when you first want to test a command that'll have a big impact.
+
+==== Use case ====
+
+You're replacing all compute-nodes in a couple of racks (2-5), and want to test your command to remove the old hardware from CMT:
+
+{{{
+user@host$ cmt --dry-run --remove hardwareunit rack={2,3,4,5} role=computenode
+}}}
+
+{{{#!comment
+=== Non-interactive run: `--script ===
+
+Sometimes you don't want to interact with CMT, after issuing a command. For example, when CMT is executed unattended from scripts. Syntax is like:
+
+{{{
+user@host$ cmt --script --{add,list,change,remove} ENTITY ...
+}}}
+
+==== Use case ====
+
+{{{
+
+}}}
+}}}
+
+=== Generate a config-file: `-g, --generate` ===
 
 Render a template to generate a config-file or a report. Use the following syntax:
@@ -186 +280 @@
 }}}
 
-=== Use case ===
+==== Use case ====
 
 '''When you want to generate the cfrun_hosts file of the Clearspeed cluster:'''
@@ -230 +324 @@
 gb-r51n8.irc.sara.nl
 }}}
-
-
-== List object(s): `-l, --list` ==
-
-Use this option to list existing objects in the database. You have to specify the entity, and filter objects you want to list by providing a query. The syntax is as follows:
-
-{{{
-cmt_sara --list <entity> [get] <query>
-}}}
-
-=== Use case ===
-
-'''If you need to figure out where a machine -- in this case `test3` -- is physically hosted:'''
-
-When an engineer has to fix a node you need to tell him the location of the node. This information shall be listed by issuing the following command:
-
-{{{
-user@host$ cmt --list hardwareunit label=test3
-}}}
-
-The output of this command looks like:
-
-{{{
- .---[  test3  ]---
- : cluster        : LDAP/CUA
- : address        : Amsterdam - Science Park 121
- : room           : S142A
- : rack           : rack AD38
- : first_slot     : 23
- : specifications : PowerEdge 1950 (Dell bv)
- : roles          : administration
- : in_support     : True
- '---
-}}}