Skip to content
cc-cli.1 25.3 KiB
Newer Older
.TH CC-CLI "MARCH 2011" LINUX "USER MAN"
gaetan deleaz's avatar
gaetan deleaz committed
.SH NAME
cc-cli - Command Line Interface to CloudControl
.SH SYNOPSIS
\fBcc-cli\fP [\fIOPTION\fP] [\fICOMMANDS\fP]

.SH DESCRIPTION
.TP
\fB--version\fP
show program's version number and exit
gaetan deleaz's avatar
gaetan deleaz committed
\fB-h\fP, \fB--help\fP
show this help message and exit
.TP
\fB-d\fP, \fB--debug\fP
Debug mode
.TP
\fB-D\fP, \fB--no-debug\fP
Unset debug mode
.TP
\fB-L\fP \fILOGIN\fP, \fB--login=\fP\fILOGIN\fP
Server login
.TP
\fB-H\fP \fISERVER\fP, \fB--hostname=\fP\fISERVER\fP
Server hostname
.TP
\fB-P\fP \fIPORT\fP, \fB--port=\fP\fIPORT\fP
Server port
.TP
\fB-t\fP \fITIMEOUT\fP, \fB--timeout=\fP\fITIMEOUT\fP
Connection timeout
.TP
\fB-p\fP \fIPROFILE\fP, \fB--profile=\fP\fIPROFILE\fP
Profile name
.TP
\fB-l\fP, \fB--list-profile\fP
List available profile
.TP
\fB--history-file=\fP\fIHISTORY\fP
History file
.TP
\fB--history-size=\fP\fIHSIZE\fP
History max entry count

.SS Loading procedure:
Configuration is loaded in this order:
.br
gaetan deleaz's avatar
gaetan deleaz committed
1 - Check \fBCC_DEBUG\fP, to set early debugging mode
gaetan deleaz's avatar
gaetan deleaz committed
.br
gaetan deleaz's avatar
gaetan deleaz committed
2 - load [cli] profile from \fB~/.config/cc-cli/profile\fP
gaetan deleaz's avatar
gaetan deleaz committed
.br
gaetan deleaz's avatar
gaetan deleaz committed
3 - load profile specified by option profile (arg line, env, cli profile)
gaetan deleaz's avatar
gaetan deleaz committed
.br
gaetan deleaz's avatar
gaetan deleaz committed
4 - load options from environment
gaetan deleaz's avatar
gaetan deleaz committed
.br
gaetan deleaz's avatar
gaetan deleaz committed
5 - load options from command line
gaetan deleaz's avatar
gaetan deleaz committed

.SH TQL
TQL (text query language)
.br
- TQL build a list of objects in one query
.br
- An object is a list of tags
.br
- TQL can select and sort object by tags
.br
- TQL can choose tags in object
.br
- TQL can limit number of objects to select
.br
- TQL is a list statement mixed by separators
.br
- TQL build his object list from left to right (left parenthesis)
.br
- Each statement update the builded list regarding his separators
.br
- Selecting, sorting and showing separators are followed by tags
.br
- Limiting separators are followed by limiting conditions
.br
- TQL always return id tag
.br
- By default separators is &
.br
- By default object list is sorted id
.br

.SS SEPERATORS
\fB&\fP selection intersection
.br
\fB|\fP selection union
.br
\fB^\fP selection limit
.br
\fB$\fP tag showing
.br
\fB%\fP tag sorting

.SS OPERATORS
\fB=\fP strict equality
.br
\fB:\fP globing matching (no case)
.br
\fB~\fP regex matching
.br
\fB>\fP superior strict
.br
\fB>=\fP superior
.br
gaetan deleaz's avatar
gaetan deleaz committed
\fB<\fP inferior strict
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB<=\fP inferior
gaetan deleaz's avatar
gaetan deleaz committed
.br
Each previous operators can be negated by adding \fB!\fP before it.

.SS LIMITING CONDITIONS
\fBn\fP limit to n first objects
.br
gaetan deleaz's avatar
gaetan deleaz committed
\fB,n\fP limit from n object to last object
gaetan deleaz's avatar
gaetan deleaz committed

.SS NUMBER FACILITY
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB1ki\fP = 1 024
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB1m\fP = 1 000 ^ 2
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB1mi\fP = 1 024 ^ 2
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB1g\fP = 1 000 ^ 3
gaetan deleaz's avatar
gaetan deleaz committed
.br
\fB1gi\fP = 1 024 ^ 3
gaetan deleaz's avatar
gaetan deleaz committed

.SS EXAMPLE
For examples, See the command \fBlist\fP
gaetan deleaz's avatar
gaetan deleaz committed

.SH GENERIC COMMANDS

.SS addaccount [\fIoptions\fP] \fI<account-name> <role>\fP [\fIpassword\fP]
Create an account
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB-help\fP
show this help message and exit
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBaddacount toto cli azerty\fP
Create account toto in role cli (user) whith password azerty

.SS addright [\fIoptions\fP] \fI<account tql> <right tql> <method> <target>\fP [\fIindex\fP]
Add or edit account right
.br
All is deny by default
.br
gaetan deleaz's avatar
gaetan deleaz committed
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
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
\fB[0] tql: method:* target:allow\fP
.br
\fB[1] tql: method:list target:deny\fP
.br
  if the user tape the command \fBlist\fP whith any tql, the command will be allowed because it matches with index 0

\fB[0] tql: method:list target:deny\fP
.br
\fB[1] tql: method:* target:allow\fP
.br
  if the user tape the command \fBlist\fP whith any tql, the command will be denied because it matches with index 0

.TP
\fI<method>\fP
is the name of the rpc command to allow
.TP
\fI<target>\fP
can be allow or deny
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
gaetan deleaz's avatar
gaetan deleaz committed
  \fBaddright id=toto "" * allow 0\fP
Allow all method whith all query tql in index 0 for account toto
gaetan deleaz's avatar
gaetan deleaz committed

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

.SS alias [\fIoptions\fP] [\fIname\fP] [\fIvalue\fP]
Show or create alias
.TP
CLI support aliasing. This is a very useful command substitution. Alias is stored in \fB~/.config/cc-cli/alias\fP
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBalias w "list a&con!=offline&r=cli"\fP
Setting an alias w, which list online client
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBalias vm "list r=vm&status=running$cpu"\fP
Setting an alias vm, which list running vm (and show cpu)

.SS clear
.TP
Clear tty

.SS close [\fIoptions\fP] \fI<tql>\fP
Disable accounts
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration

.SS declose [\fIoptions\fP] \fI<tql>\fP
Enable accounts
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration

.SS delaccount [\fIoptions\fP] \fI<tql>\fP
Delete an account
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
\fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration

.SS delright [\fIoptions\fP] \fI<tql> <index>\fP
Delete account right

.TP
\fI<index>\fP
* means all
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration

.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  if you have deny rights in the command list, for delete account right, you must use options --raw and -direct
\fBdelright -r -d id=toto x\fP


.SS expert
Switch in expert mode

Expert mode history is stored in \fB~/.local/share/cc-cli/expert\fP


.SS help
.TP
Print help


.SS history
Show commands history

CLI history is stored in \fB~/.local/share/cc-cli/history\fP


.SS kill [\fIoptions\fP] \fI<tql>\fP
Kill a server connection
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration


.SS list [\fIoptions\fP] [\fItql\fP]
List objects
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
  \fB-t\fP
column aligment display
.TP
  \fB-l\fP
line aligment display

.P
gaetan deleaz's avatar
gaetan deleaz committed
  \fBlist\fP
.br
    list all accounts

  \fBlist h:fw*\fP
.br
    list all hostname starting by fw

  \fBlist r=hv\fP
.br
    list all hypervisor

  \fBlist r=vm\fP
.br
    list all vm

  \fBlist hv=toto\fP
.br
    list vm of hypervisor toto

  \fBlist r=vm&cpu=2\fP
.br
    list vm with 2 cpu

  \fBlist r=vm&cpu=2&mem>10g\fP
.br
    list vm with 2 cpu and mem > 10g

  \fBlist r=hv&cpu=2&mem>10g\fP
.br
    list hypervisor with 2 cpu and 10G memory
gaetan deleaz's avatar
gaetan deleaz committed

  \fBlist cpu>=2$pop$alloc\fP
.br
    list object with at least 2cpu and show tags pop and alloc

  \fBlist r=vm^10\fP
.br
    list first 10 vm

  \fBlist r=vm%cpu\fP
.br
    list vm sorted by cpu


.SS passwd [\fIoptions\fP] [\fItql\fP] [\fIpassword\fP]
Change account password
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration


.SS quit
Quit application with respect


.SS rights [\fIoptions\fP] [\fItql\fP]
List account rights
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
gaetan deleaz's avatar
gaetan deleaz committed
\fB>>right id=toto\fP
.br
  a:toto
.br
  [0] tql:id=toto method:list target:deny

Display right for account with id toto.
.br
The user toto doesn't have right use method list whith a tql conained "id=toto" (deny commands' example: list id=toto, list id:t*, ...)

.SS server \fI<options>\fP
Server manipulation command
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-c\fP
show server cache
.TP
  \fB-f\fP
show server functions
.TP
  \fB-v\fP
show server version


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

The command add tql \fB&con&r~'host|hv'\fP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
  \fB-R\fP, \fB--reboot\fP
Reboot after shutdown (default)
.TP
  \fB-H\fP, \fB--halt\fP
Halt after shutdown
.TP
  \fB-F\fP
gaetan deleaz's avatar
gaetan deleaz committed
do not go through init but go down real fast


.SS unalias [\fIoptions\fP] [\fIname\fP]
Remove an alias
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit

.SS usage \fI<command>\fP
Print usage of a command

.SS version
Print cli version

.SS whoami
Show connection login

.SH TAG COMMANDS
Every tag is composed by a tagname and a tagvalue
.br
- Tagname are case insensitive, tagvalue is case sensitive
.br
- You can use globin on tagname
.br
- tagname starting by - means all tag except this one
.br
- Operators machtes on tagvalues


./certain tag sont reservé et ne peuvent etre cree modfie ou supprimer par le client
.SS RESERVERD TAGS
Reserved tags are tags with a special meaning and cannot be set or remove directly by clients
gaetan deleaz's avatar
gaetan deleaz committed
\fBid\fP : object unique identifier (eg: kvmlab-1.test5)
gaetan deleaz's avatar
gaetan deleaz committed
\fBp\fP : parent object identifier (eg: kvmlab-1)
gaetan deleaz's avatar
gaetan deleaz committed
\fBa\fP : account name (eg: bobby)
gaetan deleaz's avatar
gaetan deleaz committed
\fBr\fP : account role (host/hv/vm/cli/web/spv)
gaetan deleaz's avatar
gaetan deleaz committed
\fBclosed\fP : account close status
gaetan deleaz's avatar
gaetan deleaz committed
\fBcon\fP : connection uptime in seconds (eg: 3600)
gaetan deleaz's avatar
gaetan deleaz committed
\fBip\fP : ipv4 of connection

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

gaetan deleaz's avatar
gaetan deleaz committed
.SS addtag [\fIoptions\fP] \fI<tql> <tag> <value>\fP
Add/Modify a static tag on an account
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBaddtag id=toto hello foo\fP
Create tag hello whith value foo for account toto
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBaddtag r=vm hello foo\fP
Create tag hello whith value foo for all vm
gaetan deleaz's avatar
gaetan deleaz committed


.SS deltag [\fIoptions\fP] \fI<tql> <tag>\fP
Delete a static tag from an account
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBdeltag id=toto hello\fP
Delete tag hello from account toto

.SS tagdisplay [\fIoptions\fP] [\fItag\fP] ...
Tagdisplay tool
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-c\fP \fISET-COLOR\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
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-C\fP
Remove custom color on [\fItag\fP]
.TP
  \fB-t\fP \fISET-TYPE\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.
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-T\fP
Remove custom type on [\fItag\fP]
.TP
  \fB-f\fP \fISET-TITLE-COLOR\fP
Set custom title color on [\fItag\fP]
.TP
  \fB-F\fP
Remove custom title color on [\fItag\fP]
.TP
  \fB--list-colors\fP
List allowed color
.TP
  \fB--list-types\fP
List allowed types
\fBExample :\fP
.TP
  \fBtagdisplay -c red hv\fP
The tag hv is displayed with color red
gaetan deleaz's avatar
gaetan deleaz committed

.SS tags [\fIoptions\fP] [\fItql\fP]
List only static tags
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
\fB>>tags r=cli\fP
  id=\fBtoto\fP foo=bar hello=bye
.br
  id=\fBtiti\fP az=qwerty
List all clients' static tags
gaetan deleaz's avatar
gaetan deleaz committed

.SH JOB COMMANDS

.SS cancel [\fIoptions\fP] \fI<job_id>\fP ...
Cancel a job
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit

.SS destroy [\fIoptions\fP] \fI<tql>\fP
Force a vm to stop

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

gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
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
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
  \fB-r\fP, \fB--raw\fP
Don't append security filter to TQL
.TP
  \fB-d\fP, \fB--direct\fP
Directly send TQL to server
.TP
  \fB-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--print-tql\fP
Print TQL before sending to server
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBexecute r=hv ls\fP
Execute command ls in all hosts