From 41170ec5f90148a02014155c75d5e1d8c7797c32 Mon Sep 17 00:00:00 2001
From: "Jose M. Guisado" <jguisado@soleta.eu>
Date: Thu, 19 May 2022 09:24:37 +0200
Subject: README: add setup example and update commands

---
 README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 82 insertions(+), 6 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b3cfdec..405567d 100644
--- a/README.md
+++ b/README.md
@@ -16,18 +16,71 @@ This tool is expected to be executed from the OpenGnsys installation environment
 
 ### Commands
 
+```
+usage: ogcli [-h] [{create,list,restore,send,set,setup}]
+
+positional arguments:
+  {create,list,restore,send,set,setup}
+                        Subcommand to run
+
+options:
+  -h, --help            show this help message and exit
+```
+
+#### `create`
+
+Create images.
+
+```
+usage: ogcli create [-h] {image}
+
+positional arguments:
+  {image}
+
+options:
+  -h, --help  show this help message and exit
+```
+
 #### `list`
 
-You can list currently connected clients, managed scopes,
-boot modes, hardware profiles and specific client information.
+You can list currently connected clients, disk, scope tree,
+boot modes, hardware/software profiles, images, and specific client information.
 
 ```
-usage: ogcli list [-h] {clients,scopes,modes,hardware,client}
+usage: ogcli list [-h] {clients,scopes,modes,hardware,client,images,disks}
 
 positional arguments:
-  {clients,scopes,modes,hardware,client}
+  {clients,scopes,modes,hardware,client,images,disks}
 
-optional arguments:
+options:
+  -h, --help            show this help message and exit
+```
+
+#### `restore`
+
+Restore an image partition
+
+```
+usage: ogcli restore [-h] {image}
+
+positional arguments:
+  {image}
+
+options:
+  -h, --help  show this help message and exit
+```
+
+#### `send`
+
+Send WoL, poweroff or refresh to a given scope.
+
+```
+usage: ogcli send [-h] {wol,poweroff,refresh}
+
+positional arguments:
+  {wol,poweroff,refresh}
+
+options:
   -h, --help            show this help message and exit
 ```
 
@@ -50,18 +103,41 @@ optional arguments:
   -h, --help  show this help message and exit
 ```
 
+#### `setup`
+
+Setup disks of a given scope
+
+```
+usage: ogcli setup [-h] {disk}
+
+positional arguments:
+  {disk}
+
+options:
+  -h, --help  show this help message and exit
+```
+
 ### Objects
 
 They are subject to the specified command.
 
 * `clients`: Currently connected clients to the ogServer
 * `client`: Any specific client
+* `disk`: Client's disks
+* `images`: Partition images
 * `modes`: Network boot modes
 * `hardware`: Hardware profiles
-* `scopes`: Managed computers, rooms and centers.
+* `scopes`: Scope tree of managed computers, rooms and centers.
 
 ### Examples
 
+#### Client setup
+
+##### DOS/MBR, first partition: 40G Linux/ext4, also add a 10G OpenGnsys cache partition. Format each partition.
+```
+ogcli setup disk --type dos --part 1,LINUX,EXT4,40G --part 4,CACHE,CACHE,10G --format 1,4 --client-ip 192.168.56.11
+```
+
 #### Changing the boot mode of computers in a particular classroom
 
 ##### Fetching a classroom id
-- 
cgit v1.2.3-18-g5258