Skip to content
cc-cli.1 22.8 KiB
Newer Older
gaetan deleaz's avatar
gaetan deleaz committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
.TH CC-CLI "MARCH 2011" LINUX "MANUEL UTILISATEUR"
.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
.TP 
\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
1 Check \fBCC_DEBUG\fP, to set early debugging mode
.br
2 load [cli] profile from \fB~/.config/cc-cli/profile\fP
.br
3 load profile specified by option profile (arg line, env, cli profile)
.br
4 load options from environment
.br
5 load options from command line

.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
\fB<\fP inferior
.br
\fB<=\fP inferior strict
.br
Each previous operators can be negated by adding \fB!\fP before it.

.SS LIMITING CONDITIONS
\fBn\fP limit to n first objects
.br
\fB,n\fP limit from n objects to last object

.SS NUMBER FACILITY
\fB10k\fP = 1000
.br
\fB10ki\fP = 1024
.br
\fB1m\fP = 1000 ^ 2
.br
\fB1mi\fP = 1024 ^ 2
.br
\fB1g\fP = 1000 ^ 3
.br
\fB1gi\fP = 1024 ^ 3

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

.SH GENERIC COMMANDS

.SS addaccount [\fIoptions\fP] \fI<account-name> <role>\fP [\fIpassword\fP]
.TP
Create an account
.TP
\fBOptions:\fP
.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
\fBExample:\fP
.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
When a user tape a command, cli check the rights from index 0, 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:
\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
\fBOptions:\fP
.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
\fBExample\fP
  \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]
.TP
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
\fBOptions:\fP
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit
.TP
\fBExample:\fP
.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)

.SS clear
.TP
Clear tty

.SS close [\fIoptions\fP] \fI<tql>\fP
.TP
Disable accounts
.TP
\fBOptions:\fP
.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
.TP
Enable accounts
.TP
\fBOptions:\fP
.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
.TP
Delete an account
.TP
\fBOptions:\fP
.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
.TP
Delete account right

.TP
\fI<index>\fP
* means all
.TP
\fBOptions:\fP
.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
\fBNotes:\fP
.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
.TP
Show commands history

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


.SS kill [\fIoptions\fP] \fI<tql>\fP
.TP
Kill a server connection
.TP
\fBOptions:\fP
.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]
.TP
List objects
.TP
\fBOptions:\fP
.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
\fBExample:\fP
.br
  \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 no vm

  \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]
.TP
Change account password
.TP
\fBOptions:\fP
.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
.TP
Quit application with respect


.SS rights [\fIoptions\fP] [\fItql\fP]
.TP
List account rights
.TP
\fBOptions:\fP
.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
\fBExample:\fP
\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
.TP
Server manipulation command
.TP
\fBOptions:\fP
.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
.TP
Shutdown a physical host
.TP
\fBOptions:\fP
.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
do not go through init but go down real fast


.SS unalias [\fIoptions\fP] [\fIname\fP]
.TP
Remove an alias
.TP
\fBOptions:\fP
.TP
  \fB-h\fP, \fB--help\fP
show this help message and exit

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

.SS version
.TP
Print cli version

.SS whoami
.TP
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
.br 
\fBid\fP : object unique identifier (eg: kvmlab-1.test5)
.br 
\fBp\fP : parent object identifier (eg: kvmlab-1)
.br 
\fBa\fP : account name (eg: bobby)
.br 
\fBr\fP : account role (host/hv/vm/cli/web/spv)
.br 
\fBclosed\fP : account close status
.br 
\fBcon\fP : connection uptime in seconds (eg: 3600)
.br 
\fBip\fP : ipv4 of connection

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


.SS addtag [\fIoptions\fP] \fI<tql> <tag> <value>\fP
.TP
Add/Modify a static tag on an account
.TP
\fBOptions:\fP
.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
\fBExample:\fP
.TP
  \fBaddtag id=toto hello foo\fP
Create tag hello whith value foo in the account toto
.TP
  \fBaddtag r=vm hello foo\fP
Create tag hello whith value foo in all vm


.SS deltag [\fIoptions\fP] \fI<tql> <tag>\fP
Delete a static tag from an account
.TP
  \fBOptions:\fP
.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
\fBExample:\fP
.TP
  \fBdeltag id=toto hello\fP
Delete tag hello from account toto

.SS tagdisplay [\fIoptions\fP] [\fItag\fP] ...
Tagdisplay tool
.TP
\fBOptions:\fP
.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]
.TP
  \fB-C\fP
Remove custom color on [\fItag\fP]
.TP
  \fB-t\fP \fISET-TYPE\fP
Set custom type on [\fItag\fP]
.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

.SS tags [\fIoptions\fP] [\fItql\fP]
List only static tags
.TP
\fBOptions:\fP
.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

.SH JOB COMMANDS

.SS cancel [\fIoptions\fP] \fI<job_id>\fP ...
Cancel a job
.TP
\fBOptions:\fP
.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.

.TP
\fBOptions:\fP
.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
.TP
\fBOptions:\fP
.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 jobs [\fIoptions\fP] [\fItql\fP]
List jobs
.TP
\fBOptions:\fP
.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