Commit ea20b0f5 authored by Gaëtan Déléaz's avatar Gaëtan Déléaz
Browse files

fix manpage installation and update manpage

parent f1cdb291
Loading
Loading
Loading
Loading
+230 −130
Original line number Diff line number Diff line
@@ -119,9 +119,9 @@ Each previous operators can be negated by adding \fB!\fP before it.
\fB,n\fP limit from n object to last object

.SS NUMBER FACILITY
\fB10k\fP = 1000
\fB1k\fP = 1 000
.br
\fB10ki\fP = 1024
\fB1ki\fP = 1 024
.br
\fB1m\fP = 1 000 ^ 2
.br
@@ -132,7 +132,7 @@ Each previous operators can be negated by adding \fB!\fP before it.
\fB1gi\fP = 1 024 ^ 3

.SS EXAMPLE
For example, See the command \fBlist\fP
For examples, See the command \fBlist\fP

.SH GENERIC COMMANDS

@@ -171,7 +171,7 @@ All is deny by default
.br
When a user tape a command, cli check the rights from index 0 to the last, if the method and the right tql match whith command, right is applied, else it check the next rights, and if not found a matching rights, it deny the command
.TP
Example:
\fBExample :\fP
\fB[0] tql: method:* target:allow\fP
.br
\fB[1] tql: method:list target:deny\fP
@@ -217,13 +217,12 @@ No tagdisplay custom display
  \fB--no-color\fP
No output coloration
.TP
\fBExample\fP
\fBExample :\fP
.TP
  \fBaddright id=toto "" * allow 0\fP
.br
Allow all method whith all query tql in index 0 for account toto

  \fBaddright id=toto "id=toto" list deny 0\fP
.br
Deny method list whith tql "id=toto" for account toto in index 0 (deny commands' example: list id=toto, list id:t*, ...)

.SS alias [\fIoptions\fP] [\fIname\fP] [\fIvalue\fP]
@@ -240,6 +239,7 @@ show this help message and exit
.TP
  \fBalias w "list a&con!=offline&r=cli"\fP
Setting an alias w, which list online client

.TP
  \fBalias vm "list r=vm&status=running$cpu"\fP
Setting an alias vm, which list running vm (and show cpu)
@@ -453,7 +453,7 @@ line aligment display

.P
\fBExample :\fP
.br

  \fBlist\fP
.br
    list all accounts
@@ -484,7 +484,7 @@ line aligment display

  \fBlist r=hv&cpu=2&mem>10g\fP
.br
    list hypervisor with no vm
    list hypervisor with 2 cpu and 10G memory

  \fBlist cpu>=2$pop$alloc\fP
.br
@@ -551,6 +551,7 @@ Print TQL before sending to server
No tagdisplay custom display
.TP
\fBExample :\fP

\fB>>right id=toto\fP
.br
  a:toto
@@ -581,6 +582,8 @@ show server version

.SS shutdown [\fIoptions\fP] \fI<tql>\fP
Shutdown a physical host

The command add tql \fB&con&r~'host|hv'\fP
.TP
\fBOptions :\fP
.TP
@@ -615,6 +618,7 @@ Reboot after shutdown (default)
Halt after shutdown
.TP
  \fB-F\fP
.br
do not go through init but go down real fast


@@ -666,97 +670,97 @@ Reserved tags are tags with a special meaning and cannot be set or remove direct
\fBip\fP : ipv4 of connection

.SS WELL KNOWN TAGS
\fBh\fP : hostname (eg: access)
.br 
\fBhv\fP : hypervisor name (eg: kvmlab-1)
\fBalloc\fP : host is allowed to be selected to a migration
.br
\fBhtype\fP : hypervisor type (xen/kvm)
\fBarch\fP : hardware architecture (x86/x64)
.br
\fBlibvirtver\fP : Libvirt version
\fBchaasset\fP : blade chassis asset tag (dell tag)
.br 
\fBstatus\fP : VM status (running/paused/stopped)
\fBchaserial\fP : blade chassis serial number (dell tag)
.br 
\fBcpu\fP : cpu count
.br 
\fBrcpu\fP : reserved cpu count
\fBcpufreq\fP : cpu core frequency
.br
\fBmem\fP : memory total size
\fBcputhread\fP : total number of cpu thread
.br 
\fBmemused\fP : memory used
\fBcpuuse\fP : global cpu usage (percentage)
.br
\fBmemfree\fP : memory free
\fBdisk\fP : disk  index list (eg: 1 2 3 4)
.br 
\fBarch\fP : hardware architecture (x86/x64)
\fBdisk1_path\fP : disk 1 path (eg: /dev/vg/sex)
.br 
\fBuname\fP : output of uname command
\fBdisk1_pool\fP : storage pool back reference (eg: vg) [vmonly]
.br
\fBuptime\fP : uptime of hostname
\fBdisk1_size\fP : disk 1 size (eg: 1024)
.br 
\fBload\fP : load average
\fBdisk1_vol\fP : storage pool volume back reference (eg: titi) [vmonly]
.br
\fBos\fP: operating system (linux/windows)
\fBh\fP : hostname (eg: access)
.br 
\fBalloc\fP : host is allowed to be selected to a migration
\fBhbios\fP : host bios version and/or date (eg: A05 (01/09/2006))
.br 
\fBhvm\fP : hardware virtualisation enabled
\fBhmodel\fP : host model (eg: PowerEdge 2850)
.br
\fBnvm\fP : vm count on an hypervisor
\fBhserial\fP : host serial number (eg: Dell service tag)
.br 
\fBvmstarted\fP : started vm count on an hypervisor
\fBhtype\fP : hypervisor type (xen/kvm)
.br 
\fBvmstopped\fP : stopped vm count on an hypervisor
\fBhv\fP : hypervisor name (eg: kvmlab-1)
.br 
\fBvmpaused\fP : paused vm count on an hypervisor
\fBhvm\fP : hardware virtualisation enabled
.br
\fBversion\fP : account reported version
\fBhvendor\fP : host vendor (eg: Dell Computer Corporation)
.br 
\fBsto\fP : storage pool names (eg: vg fg)
\fBhvver\fP : hypervisor version (eg: 0.14)
.br
\fBstovg_type\fP : vg storage pool type (eg: lvm)
\fBlibvirtver\fP : Libvirt version
.br 
\fBstovg_size\fP : vg storage pool size (eg: 1042)
\fBload\fP : load average
.br 
\fBstovg_used\fP : vg storage pool used space (eg: 1)
\fBmem\fP : memory total size
.br 
\fBstovg_free\fP : vg storage pool free space (eg: 1041)
\fBmemfree\fP : memory free
.br 
\fBstovg_path\fP : vg storage pool path (eg: /dev/vg/)
\fBmemused\fP : memory used
.br 
\fBstovg_vol\fP : vg storage pool volume list (eg: sex titi toto)
\fBnvm\fP : vm count on an hypervisor
.br
\fBdisk: disk\fP  index list (eg: 1 2 3 4)
\fBos\fP : operating system (linux/windows)
.br 
\fBdisk1_path\fP : disk 1 path (eg: /dev/vg/sex)
\fBplatform\fP : python platform info
.br 
\fBdisk1_size\fP : disk 1 size (eg: 1024)
\fBrcpu\fP : reserved cpu count
.br
\fBdisk1_pool\fP : storage pool back reference (eg: vg) [vmonly]
\fBstatus\fP : VM status (running/paused/stopped)
.br
\fBdisk1_vol\fP : storage pool volume back reference (eg: titi) [vmonly]
\fBsto\fP : storage pool names (eg: vg fg)
.br
\fBvncport\fP : vnc local port (eg: 5001)
\fBstovg_free\fP : vg storage pool free space (eg: 1041)
.br 
\fBhvver\fP : hypervisor version (eg: 0.14)
\fBstovg_path\fP : vg storage pool path (eg: /dev/vg/)
.br
\fBhserial\fP : host serial number (eg: Dell service tag)
\fBstovg_size\fP : vg storage pool size (eg: 1042)
.br   
\fBhvendor\fP : host vendor (eg: Dell Computer Corporation)
\fBstovg_type\fP : vg storage pool type (eg: lvm)
.br 
\fBhmodel\fP : host model (eg: PowerEdge 2850)
\fBstovg_used\fP : vg storage pool used space (eg: 1)
.br 
\fBhbios\fP : host bios version and/or date (eg: A05 (01/09/2006))
\fBstovg_vol\fP : vg storage pool volume list (eg: sex titi toto)
.br  
\fBcputhread\fP : total number of cpu thread
\fBuname\fP : output of uname command
.br 
\fBcpufreq\fP : cpu core frequency
\fBuptime\fP : uptime of hostname
.br  
\fBcpuuse\fP : global cpu usage (percentage)
\fBversion\fP : account reported version
.br  
\fBplatform\fP : python platform info
\fBvmpaused\fP : paused vm count on an hypervisor
.br  
\fBchaserial\fP : blade chassis serial number (dell tag)
\fBvmstarted\fP : started vm count on an hypervisor
.br 
\fBchaasset\fP : blade chassis asset tag (dell tag)
\fBvmstopped\fP : stopped vm count on an hypervisor
.br 
\fBvncport\fP : vnc local port (eg: 5001)

 
.SS addtag [\fIoptions\fP] \fI<tql> <tag> <value>\fP
@@ -791,10 +795,10 @@ No output coloration
\fBExample :\fP
.TP
  \fBaddtag id=toto hello foo\fP
Create tag hello whith value foo in the account toto
Create tag hello whith value foo for account toto
.TP
  \fBaddtag r=vm hello foo\fP
Create tag hello whith value foo in all vm
Create tag hello whith value foo for all vm


.SS deltag [\fIoptions\fP] \fI<tql> <tag>\fP
@@ -840,13 +844,25 @@ Tagdisplay tool
show this help message and exit
.TP
  \fB-c\fP \fISET-COLOR\fP
Set custom color on [\fItag\fP]
Set custom color on [\fItag\fP].
.br
Color available : 
.br
  \fBregular :\fP
    \fIblack\fP, \fIred\fP, \fIgreen\fP, \fIyellow\fP, \fIblue\fP, \fIpurple\fP, \fIcyan\fP, \fIwhite\fP
  \fBlighted :\fP
    \fIlgrey\fP, \fIlred\fP, \fIlgreen\fP, \fIlyellow\fP, \fIlblue\fP, \fIlpurple\fP, \fIlcyan\fP, \fIlwhite\fP
  \fBunderline :\fP
    \fIured\fP, \fIugreen\fP, \fIuyellow\fP, \fIublue\fP, \fIupurple\fP, \fIucyan\fP
.TP
  \fB-C\fP
Remove custom color on [\fItag\fP]
.TP
  \fB-t\fP \fISET-TYPE\fP
Set custom type on [\fItag\fP]
Set custom type on [\fItag\fP].
.br
Type available : 
  \fIstring\fP, \fIlower\fP, \fIupper\fP, \fIsi\fP (system international), \fIsecond\fP, \fIdate\fP, \fItime\fP, \fIdatetime\fP.
.TP
  \fB-T\fP
Remove custom type on [\fItag\fP]
@@ -862,6 +878,11 @@ List allowed color
.TP
  \fB--list-types\fP
List allowed types
.TP 
\fBExample :\fP
.TP
  \fBtagdisplay -c red hv\fP
The tag hv is displayed with color red

.SS tags [\fIoptions\fP] [\fItql\fP]
List only static tags
@@ -891,7 +912,7 @@ No output coloration
  id=\fBtoto\fP foo=bar hello=bye
.br
  id=\fBtiti\fP az=qwerty
.br

List all clients' static tags 

.SH JOB COMMANDS
@@ -911,6 +932,8 @@ Immediately terminate the VM. This doesn't give the domain OS any chance to
react, and it's the equivalent of ripping the power cord out on a physical machine.  In most
cases you will want to use the stop command instead.

The command add tql \fI&r=vm&status!=stopped\fP

.TP
\fBOptions :\fP
.TP
@@ -940,6 +963,8 @@ No output coloration

.SS execute [\fIoptions\fP] \fI<tql> <command>\fP
Execute a command on the remote host

The command add tql \fI&con&r~'host|hv'\fP
.TP
\fBOptions :\fP
.TP
@@ -971,10 +996,7 @@ No output coloration
.TP
  \fBexecute r=hv ls\fP
Execute command ls in all hosts
.TP
.B BUG:
.br
Quand il y a une erreur, il manque un retour à la ligne apres le None


.SS jobs [\fIoptions\fP] [\fItql\fP]
List jobs
@@ -1043,6 +1065,9 @@ Migrate all vm from host1 to host2

.SS pause [\fIoptions\fP] \fI<tql>\fP
Pause a running vm

The command add tql \fI&r=vm&status=running\fP

.TP
\fBOptions :\fP
.TP
@@ -1070,18 +1095,11 @@ No tagdisplay custom display
  \fB--no-color\fP
No output coloration
.TP
\fBExample\fP
\fBExample :\fP
.TP
  \fBpause r=vm&status=running&p=host1\fP
Pause all vm started in the hypervisor host1
.TP
\fBBUG:\fP
.br
pause --print-tql r=vm&status=running&p=it-test-4
.br
TQL: r=vm&status=running&p=it-test-4&r=vm&status=stopped
.br
le TQL devrait ressembler plus à : r=vm&status=running&p=it-test-4&r=vm&status!=stopped



.SS resume [\fIoptions\fP] \fI<tql>\fP
@@ -1090,6 +1108,8 @@ Resume a paused vm
This will allow a previously paused vm to
now be eligible for scheduling by the underlying hypervisor.

The command add tql \fI&r=vm&status=paused\fP

.TP
\fBOptions :\fP
.TP
@@ -1119,6 +1139,8 @@ No output coloration

.SS start [\fIoptions\fP] \fI<tql>\fP
Start a stopped vm

The command add tql \fI&r=vm&status=stopped\fP
.TP
\fBOptions :\fP
.TP
@@ -1153,6 +1175,8 @@ This coordinates with the domain OS to perform graceful
stop, so there is no guarantee that it will succeed, and may take a variable length of
time depending on what services must be shutdown in the domain

The command add tql \fI&r=vm&status=running\fP

.TP
\fBOptions :\fP
.TP
@@ -1184,16 +1208,78 @@ No output coloration
.TP
\fB~/.config/cc-cli/profile\fP
file where cli profile is stored

  \fBExample :\fP
    # Options in this section is loaded is each others section
    [DEFAULT]
    hsize = 1000
    #debug = true

    # This section is loaded at start
    [cli]
    profile = lab

    [lab]
    login = snoopy
    pass = toto
    server = 192.168.0.162

    [prod]
    login = snoopy
    pass = titi
    server = 14.8.25.32
.TP
\fB~/.local/share/cc-cli/history\fP
file where cli history are stored
.TP
\fB~/.local/share/cc-cli/expert\fP
file where expert mode history are stored
.TP
\fB~/.config/cc-cli/tagdisplay\fP
file where tagdisplay options are stored

  \fBExample :\fP
    [color]
    a = lpurple
    h = lred
    pop = lyellow
    mem* = lyellow
    r = red
    id = lblue
    cpu = lyellow
    con = cyan

    [titlecolor]
    h = red
    id = cyan

    [type]
    uptime = second
    con = second
    disk* = si
    sto* = si
    mem* = bit

    [option]
    quotespace = 1

.TP
\fB~/.config/cc-cli/alias\fP
file where alias are stored
  
  \fBExample :\fP
    [alias]
    zzz = list r=cli&idle>300
    versions = list -t version
    hv = list r=hv&con$cpu$mem$arch%id
    vm = list r=vm&status=running$h$cpu$mem$arch%h
    userrights = rights r=cli
    lt = list -t &con%r%h$h$cpu$r$os$version$-con$mem
    ls = list &con$h$cpu$r$os$version
    w = list -l r=cli&con$os
    host = list r=host&con$cpu$mem


.SH ENVIRONNEMENT
.TP
\fBCC_SERVER\fP
@@ -1208,6 +1294,20 @@ file where alias are stored
.TP
\fBCC_PROFILE\fP

.SH BUG
.TP
\fBpause\fP
.br
pause --print-tql r=vm&status=running&p=it-test-4
.br
TQL: r=vm&status=running&p=it-test-4&r=vm&status=stopped
.br
le TQL devrait ressembler plus à : r=vm&status=running&p=it-test-4&r=vm&status!=stopped

.TP
\fBexecute\fP
Quand il y a une erreur, il manque un retour à la ligne apres le None

.SH AUTHOR
SmartJog IT

debian/cc-cli.manpages

0 → 100644
+1 −0
Original line number Diff line number Diff line
debian/cc-cli.1