Skip to content
Normal view History Permalink
cc-cli.1 22.8 KiB
Newer Older
gaetan deleaz's avatar
add man page cc-cli.1.ex
gaetan deleaz committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 
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
.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--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
\fBExample:\fP
.TP
  \fBmigrate r=vm&p=host1 id=host2\fP
Migrate all vm in host1 to host2

.SS pause [\fIoptions\fP] \fI<tql>\fP
Pause a running vm
.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
  \fBpause r=vm&status=running&p=host1\fP
Pause all vm started in the hypervisor host1

.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.

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

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

.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

.SH FILES
.TP
\fB~/.config/cc-cli/profile\fP
file where cli profile is stored
.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/alias\fP
file where alias are stored

.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

.SH AUTHOR
SmartJog IT
Show full blame