Skip to content
cc-cli.1 25.3 KiB
Newer Older
gaetan deleaz's avatar
gaetan deleaz committed
.SS jobs [\fIoptions\fP] [\fItql\fP]
List jobs
.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-d\fP, \fB--done\fP
Show done jobs
.TP
  \fB-R\fP, \fB--no-running\fP
Don't show running jobs

.SS migrate [\fIoptions\fP] [\fIsource-tql\fP] [\fIdest-tql\fP]
Migrate vm
gaetan deleaz's avatar
gaetan deleaz committed

Migrate vm from host [\fIsource-tql\fP] to another host [\fIdest-tql\fP]. Only \fBcold\fP (the virtual machine stop to execute any currently working program and copy the current page table to the machine where the virtual machine migrate) type migration and \fBfair\fP algorithm are available.
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-q\fP, \fB--quiet\fP
Don't status of call request
.TP
  \fB-i\fP, \fB--index\fP
Print TQL line index
.TP
  \fB--no-tagdisplay\fP
No tagdisplay custom display
.TP
  \fB--no-color\fP
No output coloration
.TP
  \fB-l\fP, \fB--list\fP
List migration types and algo
.TP
  \fB-t\fP \fITYPE\fP, \fB--type=\fP\fITYPE\fP
Selection migration type
.TP
  \fB-a\fP \fIALGO\fP, \fB--algo=\fP\fIALGO\fP
Select migration algorithm
.TP
gaetan deleaz's avatar
gaetan deleaz committed
.TP
gaetan deleaz's avatar
gaetan deleaz committed
  \fBmigrate -t cold -a fair r=vm&p=host1 id=host2\fP
Migrate all vm from host1 to host2
gaetan deleaz's avatar
gaetan deleaz committed

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

The command add tql \fI&r=vm&status=running\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
gaetan deleaz's avatar
gaetan deleaz committed
.TP
  \fBpause r=vm&status=running&p=host1\fP
Pause all vm started in the hypervisor host1
gaetan deleaz's avatar
gaetan deleaz committed

gaetan deleaz's avatar
gaetan deleaz committed

.SS resume [\fIoptions\fP] \fI<tql>\fP
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

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 start [\fIoptions\fP] \fI<tql>\fP
Start a stopped vm

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 stop [\fIoptions\fP] \fI<tql>\fP
Stop a running vm

This coordinates with the domain OS to perform graceful
gaetan deleaz's avatar
gaetan deleaz committed
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

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

.SH FILES
.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
gaetan deleaz's avatar
gaetan deleaz committed
.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

gaetan deleaz's avatar
gaetan deleaz committed
.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

gaetan deleaz's avatar
gaetan deleaz committed

.SH ENVIRONNEMENT
.TP
\fBCC_SERVER\fP
.TP
\fBCC_PORT\fP
.TP
\fBCC_LOGIN\fP
.TP
\fBCC_PASS\fP
.TP
\fBCC_DEBUG\fP
.TP
\fBCC_PROFILE\fP
.TP
\fBCC_PAGER\fP
gaetan deleaz's avatar
gaetan deleaz committed

.SH AUTHOR
SmartJog IT