qualys-cli 0.1.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- qualys_cli/__init__.py +1 -0
- qualys_cli/__main__.py +8 -0
- qualys_cli/audit.py +616 -0
- qualys_cli/auth.py +187 -0
- qualys_cli/cache.py +123 -0
- qualys_cli/cli.py +1168 -0
- qualys_cli/client.py +1043 -0
- qualys_cli/commands/__init__.py +0 -0
- qualys_cli/commands/asset.py +183 -0
- qualys_cli/commands/ca.py +403 -0
- qualys_cli/commands/cs.py +410 -0
- qualys_cli/commands/csam.py +752 -0
- qualys_cli/commands/etm.py +170 -0
- qualys_cli/commands/pc.py +255 -0
- qualys_cli/commands/pm.py +412 -0
- qualys_cli/commands/scanauth.py +291 -0
- qualys_cli/commands/sub.py +163 -0
- qualys_cli/commands/tc.py +539 -0
- qualys_cli/commands/user.py +104 -0
- qualys_cli/commands/vm.py +562 -0
- qualys_cli/commands/was.py +1278 -0
- qualys_cli/config.py +331 -0
- qualys_cli/extras.py +702 -0
- qualys_cli/flair.py +202 -0
- qualys_cli/formatters.py +896 -0
- qualys_cli/history.py +133 -0
- qualys_cli/http_server.py +126 -0
- qualys_cli/mcp_server.py +341 -0
- qualys_cli/metrics.py +106 -0
- qualys_cli/platforms.py +67 -0
- qualys_cli/queries.py +137 -0
- qualys_cli-0.1.1.data/data/share/qualys-cli/docs/usage.html +1230 -0
- qualys_cli-0.1.1.dist-info/METADATA +319 -0
- qualys_cli-0.1.1.dist-info/RECORD +37 -0
- qualys_cli-0.1.1.dist-info/WHEEL +4 -0
- qualys_cli-0.1.1.dist-info/entry_points.txt +2 -0
- qualys_cli-0.1.1.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,1230 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-theme="light" data-density="comfortable">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>qualys-cli — Reference</title>
|
|
7
|
+
<meta name="description" content="Reference documentation for qualys-cli — a unified command-line interface for the Qualys Cloud Platform REST APIs.">
|
|
8
|
+
<style>
|
|
9
|
+
/* ── Design tokens ────────────────────────────────────────────────────── */
|
|
10
|
+
:root{
|
|
11
|
+
--brand: #ed2e26;
|
|
12
|
+
--brand-soft: #fff1f0;
|
|
13
|
+
--brand-soft-bd: #ffd5d2;
|
|
14
|
+
--ink: #0f172a;
|
|
15
|
+
--ink-2: #334155;
|
|
16
|
+
--ink-3: #64748b;
|
|
17
|
+
--line: #e2e8f0;
|
|
18
|
+
--line-2: #f1f5f9;
|
|
19
|
+
--bg: #f8fafc;
|
|
20
|
+
--surface: #ffffff;
|
|
21
|
+
--surface-2: #f1f5f9;
|
|
22
|
+
--code-bg: #0f172a;
|
|
23
|
+
--code-fg: #e2e8f0;
|
|
24
|
+
--accent-flag: #67e8f9;
|
|
25
|
+
--accent-arg: #fcd34d;
|
|
26
|
+
--shadow-sm: 0 1px 2px rgba(15, 23, 42, .04);
|
|
27
|
+
--shadow-md: 0 4px 12px rgba(15, 23, 42, .06);
|
|
28
|
+
--radius: 10px;
|
|
29
|
+
--radius-sm: 6px;
|
|
30
|
+
--side-w: 296px;
|
|
31
|
+
--topbar-h: 56px;
|
|
32
|
+
--row-pad-y: 12px;
|
|
33
|
+
--gap-sm: 8px;
|
|
34
|
+
--gap: 14px;
|
|
35
|
+
--gap-lg: 22px;
|
|
36
|
+
}
|
|
37
|
+
[data-theme="dark"]{
|
|
38
|
+
--brand: #f87171;
|
|
39
|
+
--brand-soft: #2a1414;
|
|
40
|
+
--brand-soft-bd: #4a1f1f;
|
|
41
|
+
--ink: #e2e8f0;
|
|
42
|
+
--ink-2: #cbd5e1;
|
|
43
|
+
--ink-3: #94a3b8;
|
|
44
|
+
--line: #1e293b;
|
|
45
|
+
--line-2: #0f172a;
|
|
46
|
+
--bg: #0b1220;
|
|
47
|
+
--surface: #0f172a;
|
|
48
|
+
--surface-2: #1e293b;
|
|
49
|
+
--code-bg: #020617;
|
|
50
|
+
--code-fg: #cbd5e1;
|
|
51
|
+
}
|
|
52
|
+
[data-density="compact"]{
|
|
53
|
+
--row-pad-y: 8px;
|
|
54
|
+
--gap-sm: 6px;
|
|
55
|
+
--gap: 10px;
|
|
56
|
+
--gap-lg: 14px;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
*,*::before,*::after{box-sizing:border-box}
|
|
60
|
+
html{scroll-behavior:smooth;text-size-adjust:100%}
|
|
61
|
+
body{
|
|
62
|
+
margin:0;
|
|
63
|
+
font:15px/1.6 -apple-system,BlinkMacSystemFont,"Segoe UI","Inter",Roboto,Helvetica,Arial,sans-serif;
|
|
64
|
+
color:var(--ink);background:var(--bg);
|
|
65
|
+
-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;
|
|
66
|
+
}
|
|
67
|
+
code,pre,.mono{
|
|
68
|
+
font-family:"SF Mono","JetBrains Mono","Fira Code",Menlo,Monaco,Consolas,monospace;
|
|
69
|
+
font-size:.92em;
|
|
70
|
+
}
|
|
71
|
+
a{color:var(--brand);text-decoration:none}
|
|
72
|
+
a:hover{text-decoration:underline}
|
|
73
|
+
h1,h2,h3,h4{letter-spacing:-.012em;color:var(--ink)}
|
|
74
|
+
|
|
75
|
+
/* ── Layout: sidebar + main ───────────────────────────────────────────── */
|
|
76
|
+
.app{display:grid;grid-template-columns:var(--side-w) 1fr;min-height:100vh}
|
|
77
|
+
|
|
78
|
+
/* ── Sidebar ──────────────────────────────────────────────────────────── */
|
|
79
|
+
aside.sidebar{
|
|
80
|
+
position:sticky;top:0;align-self:start;
|
|
81
|
+
height:100vh;overflow:hidden;
|
|
82
|
+
background:var(--surface);border-right:1px solid var(--line);
|
|
83
|
+
display:flex;flex-direction:column;
|
|
84
|
+
}
|
|
85
|
+
.side-header{
|
|
86
|
+
padding:18px 20px 10px;border-bottom:1px solid var(--line-2);
|
|
87
|
+
display:flex;align-items:center;gap:10px;
|
|
88
|
+
}
|
|
89
|
+
.side-header img{height:24px;display:block}
|
|
90
|
+
.side-header .ver{
|
|
91
|
+
margin-left:auto;font-size:.7rem;color:var(--ink-3);
|
|
92
|
+
background:var(--surface-2);border:1px solid var(--line);
|
|
93
|
+
padding:2px 8px;border-radius:999px;font-weight:600;
|
|
94
|
+
}
|
|
95
|
+
.side-search{
|
|
96
|
+
padding:12px 16px;border-bottom:1px solid var(--line-2);position:relative;
|
|
97
|
+
}
|
|
98
|
+
.side-search input{
|
|
99
|
+
width:100%;padding:8px 12px 8px 32px;
|
|
100
|
+
border:1px solid var(--line);border-radius:var(--radius-sm);
|
|
101
|
+
background:var(--bg);color:var(--ink);
|
|
102
|
+
font:14px -apple-system,BlinkMacSystemFont,"Segoe UI",sans-serif;
|
|
103
|
+
transition:border-color .12s, box-shadow .12s;
|
|
104
|
+
}
|
|
105
|
+
.side-search input:focus{
|
|
106
|
+
outline:none;border-color:var(--brand);
|
|
107
|
+
box-shadow:0 0 0 3px rgba(237,46,38,.12);
|
|
108
|
+
}
|
|
109
|
+
.side-search::before{
|
|
110
|
+
content:"";position:absolute;left:26px;top:50%;
|
|
111
|
+
width:14px;height:14px;transform:translateY(-50%);pointer-events:none;
|
|
112
|
+
background:url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke='%2364748b' stroke-width='2.5'><circle cx='10.5' cy='10.5' r='6.5'/><path d='M20 20l-4.5-4.5'/></svg>") center/contain no-repeat;
|
|
113
|
+
}
|
|
114
|
+
.side-search .kbd{
|
|
115
|
+
position:absolute;right:24px;top:50%;transform:translateY(-50%);
|
|
116
|
+
font:11px "SF Mono",Menlo,monospace;color:var(--ink-3);
|
|
117
|
+
background:var(--surface-2);border:1px solid var(--line);
|
|
118
|
+
padding:1px 6px;border-radius:4px;pointer-events:none;
|
|
119
|
+
}
|
|
120
|
+
/* Inline kbd tokens used in prose (e.g. "press Cmd-Q") */
|
|
121
|
+
kbd{
|
|
122
|
+
font:11px "SF Mono","JetBrains Mono",Menlo,Monaco,Consolas,monospace;
|
|
123
|
+
color:var(--ink-2);background:var(--surface-2);
|
|
124
|
+
border:1px solid var(--line);border-bottom-width:2px;
|
|
125
|
+
padding:1px 6px;border-radius:4px;display:inline-block;line-height:1.2;
|
|
126
|
+
}
|
|
127
|
+
.side-tree{
|
|
128
|
+
flex:1;overflow-y:auto;padding:10px 6px 14px;
|
|
129
|
+
}
|
|
130
|
+
.side-tree::-webkit-scrollbar{width:8px}
|
|
131
|
+
.side-tree::-webkit-scrollbar-thumb{background:var(--line);border-radius:4px}
|
|
132
|
+
.side-tree::-webkit-scrollbar-thumb:hover{background:var(--ink-3)}
|
|
133
|
+
|
|
134
|
+
.side-link{
|
|
135
|
+
display:block;padding:7px 14px;border-radius:5px;margin:0 8px;
|
|
136
|
+
font-size:.85rem;color:var(--ink-2);font-weight:500;
|
|
137
|
+
}
|
|
138
|
+
.side-link:hover{background:var(--surface-2);color:var(--brand);text-decoration:none}
|
|
139
|
+
.side-link.active{background:var(--brand-soft);color:var(--brand)}
|
|
140
|
+
|
|
141
|
+
.side-domain{
|
|
142
|
+
padding:14px 14px 4px 14px;
|
|
143
|
+
font-size:.66rem;font-weight:700;letter-spacing:.08em;
|
|
144
|
+
color:var(--ink-3);text-transform:uppercase;
|
|
145
|
+
}
|
|
146
|
+
.side-mod{margin:0 8px}
|
|
147
|
+
.side-mod-sum{
|
|
148
|
+
cursor:pointer;list-style:none;
|
|
149
|
+
display:flex;align-items:center;gap:8px;
|
|
150
|
+
padding:7px 10px;border-radius:5px;
|
|
151
|
+
color:var(--ink-2);font-size:.85rem;font-weight:500;
|
|
152
|
+
transition:background .12s, color .12s;user-select:none;
|
|
153
|
+
}
|
|
154
|
+
.side-mod-sum::-webkit-details-marker{display:none}
|
|
155
|
+
.side-mod-sum::before{
|
|
156
|
+
content:"";display:inline-block;width:7px;height:7px;
|
|
157
|
+
border-right:1.5px solid var(--ink-3);border-bottom:1.5px solid var(--ink-3);
|
|
158
|
+
transform:rotate(-45deg);transition:transform .12s;flex-shrink:0;
|
|
159
|
+
}
|
|
160
|
+
.side-mod[open] > .side-mod-sum::before{transform:rotate(45deg)}
|
|
161
|
+
.side-mod-sum:hover{background:var(--surface-2);color:var(--brand)}
|
|
162
|
+
.side-mod.active > .side-mod-sum{background:var(--brand-soft);color:var(--brand)}
|
|
163
|
+
.side-mod-badge{
|
|
164
|
+
font-size:.62rem;font-weight:700;letter-spacing:.05em;
|
|
165
|
+
background:var(--ink);color:var(--surface);
|
|
166
|
+
padding:2px 6px;border-radius:3px;font-family:inherit;
|
|
167
|
+
}
|
|
168
|
+
[data-theme="dark"] .side-mod-badge{background:var(--ink-3);color:var(--surface)}
|
|
169
|
+
.side-mod-title{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}
|
|
170
|
+
.side-mod-count{
|
|
171
|
+
font-size:.7rem;color:var(--ink-3);font-weight:600;
|
|
172
|
+
background:var(--surface-2);padding:1px 6px;border-radius:999px;
|
|
173
|
+
}
|
|
174
|
+
.side-mod-body{padding:4px 0 8px 18px}
|
|
175
|
+
.side-grp{margin:4px 0}
|
|
176
|
+
.side-grp-link{
|
|
177
|
+
display:flex;align-items:center;gap:6px;
|
|
178
|
+
padding:5px 8px;border-radius:4px;
|
|
179
|
+
font-size:.78rem;color:var(--ink-2);font-weight:600;
|
|
180
|
+
text-decoration:none;
|
|
181
|
+
}
|
|
182
|
+
.side-grp-link:hover{background:var(--surface-2);color:var(--brand);text-decoration:none}
|
|
183
|
+
.side-grp-link > span:first-child{flex:1}
|
|
184
|
+
.side-grp-count{color:var(--ink-3);font-size:.7rem;font-weight:500}
|
|
185
|
+
.side-cmds{display:flex;flex-direction:column;gap:0;padding-left:4px;margin-top:2px}
|
|
186
|
+
.side-cmd{
|
|
187
|
+
padding:4px 8px;border-radius:3px;font-size:.78rem;color:var(--ink-3);
|
|
188
|
+
font-family:"SF Mono",Menlo,Monaco,Consolas,monospace;
|
|
189
|
+
text-decoration:none;border-left:2px solid transparent;margin-left:4px;
|
|
190
|
+
}
|
|
191
|
+
.side-cmd:hover{background:var(--surface-2);color:var(--brand);text-decoration:none}
|
|
192
|
+
.side-cmd.active{
|
|
193
|
+
background:var(--brand-soft);color:var(--brand);border-left-color:var(--brand);
|
|
194
|
+
}
|
|
195
|
+
.side-footer{
|
|
196
|
+
padding:12px 18px;border-top:1px solid var(--line-2);
|
|
197
|
+
font-size:.72rem;color:var(--ink-3);display:flex;align-items:center;gap:10px;
|
|
198
|
+
}
|
|
199
|
+
.side-footer a{color:var(--ink-3)}
|
|
200
|
+
.side-footer a:hover{color:var(--brand)}
|
|
201
|
+
|
|
202
|
+
/* ── Topbar ───────────────────────────────────────────────────────────── */
|
|
203
|
+
.topbar{
|
|
204
|
+
position:sticky;top:0;z-index:30;
|
|
205
|
+
height:var(--topbar-h);
|
|
206
|
+
background:rgba(255,255,255,.92);backdrop-filter:saturate(180%) blur(10px);
|
|
207
|
+
-webkit-backdrop-filter:saturate(180%) blur(10px);
|
|
208
|
+
border-bottom:1px solid var(--line);
|
|
209
|
+
display:flex;align-items:center;gap:12px;padding:0 28px;
|
|
210
|
+
}
|
|
211
|
+
[data-theme="dark"] .topbar{background:rgba(15,23,42,.85)}
|
|
212
|
+
.topbar .crumbs{
|
|
213
|
+
display:flex;align-items:center;gap:8px;flex:1;
|
|
214
|
+
color:var(--ink-3);font-size:.85rem;
|
|
215
|
+
}
|
|
216
|
+
.topbar .crumbs strong{color:var(--ink);font-weight:600}
|
|
217
|
+
.topbar .crumb-sep{color:var(--ink-3);opacity:.6}
|
|
218
|
+
.tb-action{
|
|
219
|
+
border:1px solid var(--line);background:var(--surface);color:var(--ink-2);
|
|
220
|
+
padding:6px 12px;border-radius:var(--radius-sm);
|
|
221
|
+
font:13px -apple-system,BlinkMacSystemFont,"Segoe UI",sans-serif;
|
|
222
|
+
cursor:pointer;display:inline-flex;align-items:center;gap:6px;
|
|
223
|
+
transition:background .12s, color .12s, border-color .12s;
|
|
224
|
+
}
|
|
225
|
+
.tb-action:hover{background:var(--surface-2);color:var(--brand);border-color:var(--brand)}
|
|
226
|
+
.tb-action[aria-pressed="true"]{
|
|
227
|
+
background:var(--brand-soft);color:var(--brand);border-color:var(--brand-soft-bd);
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/* ── Main ─────────────────────────────────────────────────────────────── */
|
|
231
|
+
main{padding:0}
|
|
232
|
+
.wrap{max-width:1040px;margin:0 auto;padding:36px 32px 56px}
|
|
233
|
+
|
|
234
|
+
/* Hero */
|
|
235
|
+
.hero{
|
|
236
|
+
border-radius:var(--radius);overflow:hidden;
|
|
237
|
+
background:var(--surface);border:1px solid var(--line);
|
|
238
|
+
margin:0 0 var(--gap-lg);
|
|
239
|
+
}
|
|
240
|
+
.hero-top{
|
|
241
|
+
display:flex;align-items:center;gap:24px;padding:28px 32px;flex-wrap:wrap;
|
|
242
|
+
border-bottom:1px solid var(--line-2);
|
|
243
|
+
}
|
|
244
|
+
.hero-top h1{
|
|
245
|
+
margin:0;font-size:1.75rem;font-weight:700;letter-spacing:-.02em;
|
|
246
|
+
}
|
|
247
|
+
.hero-top h1 .mark{color:var(--brand)}
|
|
248
|
+
.hero-top p{margin:6px 0 0;color:var(--ink-3);font-size:.95rem}
|
|
249
|
+
.hero-stats{
|
|
250
|
+
display:flex;gap:14px;flex-wrap:wrap;padding:18px 32px;
|
|
251
|
+
background:var(--surface-2);
|
|
252
|
+
}
|
|
253
|
+
.hero-stat{
|
|
254
|
+
flex:1 1 130px;min-width:130px;
|
|
255
|
+
padding:10px 14px;background:var(--surface);
|
|
256
|
+
border:1px solid var(--line);border-radius:var(--radius-sm);
|
|
257
|
+
}
|
|
258
|
+
.hero-stat .n{font-size:1.4rem;font-weight:700;color:var(--ink);line-height:1.1;display:block}
|
|
259
|
+
.hero-stat .l{font-size:.7rem;color:var(--ink-3);text-transform:uppercase;letter-spacing:.06em;font-weight:600;margin-top:4px}
|
|
260
|
+
|
|
261
|
+
/* Quick start cards */
|
|
262
|
+
.quickstart{
|
|
263
|
+
display:grid;grid-template-columns:repeat(auto-fit,minmax(220px,1fr));
|
|
264
|
+
gap:var(--gap-sm);margin:0 0 var(--gap-lg);
|
|
265
|
+
}
|
|
266
|
+
.qcard{
|
|
267
|
+
background:var(--surface);border:1px solid var(--line);border-radius:var(--radius);
|
|
268
|
+
padding:16px 18px;
|
|
269
|
+
}
|
|
270
|
+
.qcard h3{
|
|
271
|
+
margin:0 0 8px;font-size:.74rem;font-weight:700;color:var(--ink-3);
|
|
272
|
+
text-transform:uppercase;letter-spacing:.06em;display:flex;align-items:center;gap:8px;
|
|
273
|
+
}
|
|
274
|
+
.qcard .step{
|
|
275
|
+
display:inline-flex;align-items:center;justify-content:center;
|
|
276
|
+
width:20px;height:20px;border-radius:50%;
|
|
277
|
+
background:var(--brand);color:#fff;font-size:.72rem;font-weight:700;
|
|
278
|
+
}
|
|
279
|
+
.qcard pre{
|
|
280
|
+
margin:0;background:var(--code-bg);color:var(--code-fg);
|
|
281
|
+
padding:9px 12px;border-radius:5px;font-size:.84rem;overflow-x:auto;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
/* Generic section card */
|
|
285
|
+
section.card{
|
|
286
|
+
background:var(--surface);border:1px solid var(--line);border-radius:var(--radius);
|
|
287
|
+
padding:24px 28px;margin:0 0 var(--gap-lg);
|
|
288
|
+
}
|
|
289
|
+
section.card > h2{
|
|
290
|
+
margin:0 0 6px;font-size:1.1rem;font-weight:700;color:var(--ink);
|
|
291
|
+
}
|
|
292
|
+
section.card > .lead{
|
|
293
|
+
color:var(--ink-3);font-size:.92rem;margin:0 0 18px;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
table.refs{width:100%;border-collapse:collapse;font-size:.9rem}
|
|
297
|
+
table.refs th, table.refs td{
|
|
298
|
+
text-align:left;padding:10px 0;border-bottom:1px solid var(--line-2);
|
|
299
|
+
vertical-align:top;
|
|
300
|
+
}
|
|
301
|
+
table.refs th{
|
|
302
|
+
color:var(--ink-3);font-weight:700;font-size:.7rem;
|
|
303
|
+
text-transform:uppercase;letter-spacing:.06em;
|
|
304
|
+
}
|
|
305
|
+
table.refs tr:last-child td{border-bottom:none}
|
|
306
|
+
table.refs td:first-child{padding-right:24px;width:38%}
|
|
307
|
+
table.refs code{
|
|
308
|
+
background:var(--surface-2);padding:2px 7px;border-radius:4px;
|
|
309
|
+
color:var(--brand);font-weight:500;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
/* Security/resiliency feature grid */
|
|
313
|
+
.feat-grid{
|
|
314
|
+
display:grid;grid-template-columns:repeat(auto-fit,minmax(240px,1fr));gap:var(--gap-sm);
|
|
315
|
+
}
|
|
316
|
+
.feat{
|
|
317
|
+
padding:14px 16px;background:var(--surface-2);border:1px solid var(--line);
|
|
318
|
+
border-radius:var(--radius-sm);
|
|
319
|
+
}
|
|
320
|
+
.feat .feat-h{font-weight:700;color:var(--ink);font-size:.92rem;margin-bottom:6px;display:flex;align-items:center;gap:8px}
|
|
321
|
+
.feat .feat-icon{
|
|
322
|
+
width:8px;height:8px;border-radius:50%;background:var(--brand);flex-shrink:0;
|
|
323
|
+
}
|
|
324
|
+
.feat p{margin:0;color:var(--ink-3);font-size:.84rem;line-height:1.55}
|
|
325
|
+
|
|
326
|
+
/* Module section */
|
|
327
|
+
section.module{
|
|
328
|
+
background:var(--surface);border:1px solid var(--line);border-radius:var(--radius);
|
|
329
|
+
margin:0 0 var(--gap-lg);overflow:hidden;
|
|
330
|
+
}
|
|
331
|
+
.module-head{
|
|
332
|
+
display:flex;align-items:center;gap:18px;flex-wrap:wrap;
|
|
333
|
+
padding:22px 28px;border-bottom:1px solid var(--line-2);
|
|
334
|
+
}
|
|
335
|
+
.mod-badge{
|
|
336
|
+
flex-shrink:0;width:42px;height:42px;border-radius:8px;
|
|
337
|
+
background:var(--ink);color:var(--surface);
|
|
338
|
+
display:flex;align-items:center;justify-content:center;
|
|
339
|
+
font-weight:700;font-size:.78rem;letter-spacing:.04em;
|
|
340
|
+
}
|
|
341
|
+
[data-theme="dark"] .mod-badge{background:var(--brand);color:#fff}
|
|
342
|
+
.mod-title{flex:1;min-width:200px}
|
|
343
|
+
.mod-title h2{
|
|
344
|
+
margin:0;font-size:1.2rem;font-weight:700;color:var(--ink);
|
|
345
|
+
letter-spacing:-.01em;
|
|
346
|
+
}
|
|
347
|
+
.mod-title .mod-sub{margin:3px 0 0;color:var(--ink-3);font-size:.86rem}
|
|
348
|
+
.mod-meta{display:flex;align-items:center;gap:10px;flex-wrap:wrap}
|
|
349
|
+
.mod-count{
|
|
350
|
+
color:var(--ink-3);font-size:.78rem;font-weight:500;
|
|
351
|
+
background:var(--surface-2);padding:4px 10px;border-radius:999px;
|
|
352
|
+
}
|
|
353
|
+
.auth{
|
|
354
|
+
padding:4px 10px;border-radius:999px;font-size:.7rem;font-weight:600;
|
|
355
|
+
text-transform:uppercase;letter-spacing:.05em;white-space:nowrap;
|
|
356
|
+
}
|
|
357
|
+
.auth.basic{background:#eff6ff;color:#1d4ed8;border:1px solid #dbeafe}
|
|
358
|
+
.auth.jwt{background:#fffbeb;color:#b45309;border:1px solid #fde68a}
|
|
359
|
+
.auth.mixed{background:#eef2ff;color:#4338ca;border:1px solid #e0e7ff}
|
|
360
|
+
[data-theme="dark"] .auth.basic{background:#172554;color:#93c5fd;border-color:#1e40af}
|
|
361
|
+
[data-theme="dark"] .auth.jwt{background:#451a03;color:#fbbf24;border-color:#92400e}
|
|
362
|
+
[data-theme="dark"] .auth.mixed{background:#312e81;color:#a5b4fc;border-color:#4338ca}
|
|
363
|
+
|
|
364
|
+
.module-toc{
|
|
365
|
+
display:flex;align-items:center;gap:8px;flex-wrap:wrap;
|
|
366
|
+
padding:14px 28px;background:var(--surface-2);
|
|
367
|
+
border-bottom:1px solid var(--line-2);
|
|
368
|
+
}
|
|
369
|
+
.module-toc-label{
|
|
370
|
+
font-size:.7rem;color:var(--ink-3);font-weight:700;
|
|
371
|
+
text-transform:uppercase;letter-spacing:.06em;margin-right:6px;
|
|
372
|
+
}
|
|
373
|
+
.grp-chip{
|
|
374
|
+
display:inline-flex;align-items:center;gap:6px;
|
|
375
|
+
padding:4px 10px;border-radius:999px;
|
|
376
|
+
background:var(--surface);border:1px solid var(--line);
|
|
377
|
+
color:var(--ink-2);font-size:.78rem;font-weight:600;
|
|
378
|
+
}
|
|
379
|
+
.grp-chip:hover{
|
|
380
|
+
background:var(--brand-soft);border-color:var(--brand-soft-bd);
|
|
381
|
+
color:var(--brand);text-decoration:none;
|
|
382
|
+
}
|
|
383
|
+
.grp-chip .chip-count{
|
|
384
|
+
color:var(--ink-3);font-size:.7rem;font-weight:500;
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
.module-body{padding:6px 28px 24px}
|
|
388
|
+
|
|
389
|
+
/* Group within a module */
|
|
390
|
+
.grp{margin-top:20px;scroll-margin-top:calc(var(--topbar-h) + 12px)}
|
|
391
|
+
.grp:first-child{margin-top:8px}
|
|
392
|
+
.grp-title{
|
|
393
|
+
margin:0 0 12px;font-size:.78rem;font-weight:700;color:var(--ink-2);
|
|
394
|
+
text-transform:uppercase;letter-spacing:.08em;
|
|
395
|
+
display:flex;align-items:center;gap:10px;
|
|
396
|
+
}
|
|
397
|
+
.grp-name{color:var(--ink-2)}
|
|
398
|
+
.grp-title .grp-count{
|
|
399
|
+
background:var(--surface-2);color:var(--ink-3);
|
|
400
|
+
padding:2px 9px;border-radius:999px;font-size:.7rem;font-weight:600;
|
|
401
|
+
}
|
|
402
|
+
.grp-body{display:flex;flex-direction:column;gap:8px}
|
|
403
|
+
|
|
404
|
+
/* Command card */
|
|
405
|
+
.cmd{
|
|
406
|
+
background:var(--surface);border:1px solid var(--line);border-radius:var(--radius-sm);
|
|
407
|
+
padding:14px 16px var(--row-pad-y);transition:border-color .15s, box-shadow .15s;
|
|
408
|
+
scroll-margin-top:calc(var(--topbar-h) + 12px);
|
|
409
|
+
}
|
|
410
|
+
.cmd:hover{border-color:var(--ink-3);box-shadow:var(--shadow-sm)}
|
|
411
|
+
.cmd:target{border-color:var(--brand);box-shadow:0 0 0 3px var(--brand-soft)}
|
|
412
|
+
|
|
413
|
+
.cmd-head{display:flex;flex-wrap:wrap;align-items:baseline;gap:10px;margin-bottom:6px}
|
|
414
|
+
.cmd-head .crumbs{
|
|
415
|
+
width:100%;display:flex;align-items:center;gap:6px;
|
|
416
|
+
color:var(--ink-3);font-size:.7rem;font-weight:600;
|
|
417
|
+
text-transform:uppercase;letter-spacing:.06em;margin-bottom:2px;
|
|
418
|
+
}
|
|
419
|
+
.cmd-head .crumb-sep{opacity:.6}
|
|
420
|
+
.cmd-full{
|
|
421
|
+
background:transparent;color:var(--ink);font-weight:600;font-size:.96rem;
|
|
422
|
+
padding:0;border-radius:0;
|
|
423
|
+
}
|
|
424
|
+
.cmd-full .verb{color:var(--brand)}
|
|
425
|
+
.cmd-summary{
|
|
426
|
+
flex:1;min-width:240px;color:var(--ink-3);font-size:.86rem;margin:0;
|
|
427
|
+
}
|
|
428
|
+
.cmd-doc-link{
|
|
429
|
+
font-size:.74rem;color:var(--ink-3);font-weight:600;
|
|
430
|
+
padding:2px 8px;border-radius:4px;
|
|
431
|
+
background:var(--surface-2);border:1px solid var(--line);
|
|
432
|
+
}
|
|
433
|
+
.cmd-doc-link:hover{
|
|
434
|
+
background:var(--brand-soft);color:var(--brand);
|
|
435
|
+
border-color:var(--brand-soft-bd);text-decoration:none;
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
.cmd-eg-wrap{position:relative;margin-top:8px}
|
|
439
|
+
.cmd-eg{
|
|
440
|
+
margin:0;background:var(--code-bg);color:var(--code-fg);
|
|
441
|
+
padding:9px 56px 9px 12px;border-radius:5px;font-size:.84rem;line-height:1.5;
|
|
442
|
+
overflow-x:auto;white-space:pre;
|
|
443
|
+
}
|
|
444
|
+
.cmd-eg .flag{color:var(--accent-flag);font-weight:500}
|
|
445
|
+
.cmd-eg .arg{color:var(--accent-arg)}
|
|
446
|
+
.copy-btn{
|
|
447
|
+
position:absolute;top:6px;right:6px;
|
|
448
|
+
border:1px solid rgba(255,255,255,.15);background:rgba(255,255,255,.06);
|
|
449
|
+
color:var(--code-fg);font:11px "SF Mono",Menlo,monospace;
|
|
450
|
+
padding:3px 9px;border-radius:4px;cursor:pointer;
|
|
451
|
+
opacity:.6;transition:opacity .12s, background .12s;
|
|
452
|
+
}
|
|
453
|
+
.cmd-eg-wrap:hover .copy-btn{opacity:1}
|
|
454
|
+
.copy-btn:hover{background:rgba(255,255,255,.14)}
|
|
455
|
+
.copy-btn.ok{background:rgba(34,197,94,.25);border-color:rgba(34,197,94,.45);opacity:1}
|
|
456
|
+
|
|
457
|
+
/* Collapsible options */
|
|
458
|
+
.opts-toggle{margin-top:10px}
|
|
459
|
+
.opts-toggle > summary{
|
|
460
|
+
cursor:pointer;list-style:none;
|
|
461
|
+
display:inline-flex;align-items:center;gap:8px;
|
|
462
|
+
color:var(--ink-2);font-size:.82rem;font-weight:500;
|
|
463
|
+
padding:5px 10px;background:var(--surface-2);
|
|
464
|
+
border-radius:5px;border:1px solid var(--line);
|
|
465
|
+
transition:background .12s, border-color .12s;user-select:none;
|
|
466
|
+
}
|
|
467
|
+
.opts-toggle > summary:hover{background:var(--line-2);border-color:var(--ink-3)}
|
|
468
|
+
.opts-toggle > summary::-webkit-details-marker{display:none}
|
|
469
|
+
.opts-toggle > summary::before{
|
|
470
|
+
content:"";display:inline-block;width:8px;height:8px;
|
|
471
|
+
border-right:1.5px solid var(--ink-3);border-bottom:1.5px solid var(--ink-3);
|
|
472
|
+
transform:rotate(-45deg);transition:transform .15s;
|
|
473
|
+
}
|
|
474
|
+
.opts-toggle[open] > summary::before{transform:rotate(45deg)}
|
|
475
|
+
.opts-toggle .cnt-req{color:var(--brand);font-weight:600}
|
|
476
|
+
.opts-toggle .cnt-cond{color:#b45309;font-weight:600}
|
|
477
|
+
[data-theme="dark"] .opts-toggle .cnt-cond{color:#fbbf24}
|
|
478
|
+
.opts-toggle .cnt-opt{color:var(--ink-3)}
|
|
479
|
+
|
|
480
|
+
.opt-note{
|
|
481
|
+
margin:12px 0 0;padding:10px 12px;
|
|
482
|
+
background:#fffbeb;border:1px solid #fde68a;border-radius:6px;
|
|
483
|
+
color:#78350f;font-size:.85rem;
|
|
484
|
+
}
|
|
485
|
+
[data-theme="dark"] .opt-note{background:#451a03;border-color:#92400e;color:#fde68a}
|
|
486
|
+
.opt-note strong{color:#92400e}
|
|
487
|
+
[data-theme="dark"] .opt-note strong{color:#fbbf24}
|
|
488
|
+
.opt-note-sub{color:#a16207}
|
|
489
|
+
[data-theme="dark"] .opt-note-sub{color:#fcd34d}
|
|
490
|
+
.opt-note .chip{
|
|
491
|
+
background:#fff;border:1px solid #fde68a;color:#92400e;font-weight:600;
|
|
492
|
+
}
|
|
493
|
+
[data-theme="dark"] .opt-note .chip{background:#1c1004;border-color:#92400e;color:#fbbf24}
|
|
494
|
+
|
|
495
|
+
.opts-list{
|
|
496
|
+
list-style:none;margin:12px 0 4px;padding:0;
|
|
497
|
+
display:flex;flex-direction:column;gap:0;
|
|
498
|
+
border:1px solid var(--line-2);border-radius:6px;overflow:hidden;
|
|
499
|
+
}
|
|
500
|
+
.opt-row{
|
|
501
|
+
padding:var(--row-pad-y) 14px;border-bottom:1px solid var(--line-2);
|
|
502
|
+
background:var(--surface);
|
|
503
|
+
}
|
|
504
|
+
.opt-row:last-child{border-bottom:none}
|
|
505
|
+
.opt-row:nth-child(even){background:var(--bg)}
|
|
506
|
+
|
|
507
|
+
.opt-name{
|
|
508
|
+
font-family:"SF Mono","JetBrains Mono",Menlo,Monaco,Consolas,monospace;
|
|
509
|
+
font-size:.86rem;line-height:1.5;
|
|
510
|
+
}
|
|
511
|
+
.opt{color:var(--brand);font-weight:600}
|
|
512
|
+
.opt-alt{color:var(--ink-3);font-weight:500;margin-left:6px;font-size:.82rem}
|
|
513
|
+
|
|
514
|
+
.opt-meta-bar{display:flex;gap:6px;flex-wrap:wrap;margin-top:6px}
|
|
515
|
+
.b-type, .b-req, .b-arg, .b-cond{
|
|
516
|
+
padding:2px 8px;border-radius:4px;font-size:.66rem;font-weight:700;
|
|
517
|
+
letter-spacing:.05em;font-family:inherit;
|
|
518
|
+
}
|
|
519
|
+
.b-type{background:var(--surface-2);color:var(--ink-2);border:1px solid var(--line)}
|
|
520
|
+
.b-req{background:var(--brand);color:#fff}
|
|
521
|
+
.b-arg{background:#eef2ff;color:#4338ca;border:1px solid #e0e7ff}
|
|
522
|
+
[data-theme="dark"] .b-arg{background:#312e81;color:#a5b4fc;border-color:#4338ca}
|
|
523
|
+
.b-cond{background:#fffbeb;color:#92400e;border:1px solid #fde68a}
|
|
524
|
+
[data-theme="dark"] .b-cond{background:#451a03;color:#fbbf24;border-color:#92400e}
|
|
525
|
+
|
|
526
|
+
.opt-body{margin-top:6px}
|
|
527
|
+
.opt-help{color:var(--ink-2);font-size:.86rem;line-height:1.5}
|
|
528
|
+
.opt-meta{margin-top:5px;color:var(--ink-3);font-size:.82rem}
|
|
529
|
+
.opt-meta-key{
|
|
530
|
+
display:inline-block;font-size:.66rem;font-weight:700;letter-spacing:.06em;
|
|
531
|
+
text-transform:uppercase;color:var(--ink-3);margin-right:6px;
|
|
532
|
+
}
|
|
533
|
+
.chip{
|
|
534
|
+
background:var(--surface-2);border:1px solid var(--line);
|
|
535
|
+
padding:1px 7px;border-radius:4px;color:var(--ink-2);
|
|
536
|
+
font-size:.78rem;font-family:"SF Mono",Menlo,Monaco,Consolas,monospace;
|
|
537
|
+
display:inline-block;margin:1px 2px;
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
/* Filter (sidebar + main) */
|
|
541
|
+
body.filtering .cmd:not(.match){display:none}
|
|
542
|
+
body.filtering .grp.empty{display:none}
|
|
543
|
+
body.filtering section.module.empty{display:none}
|
|
544
|
+
body.filtering .side-cmd:not(.match){display:none}
|
|
545
|
+
body.filtering .side-grp.empty{display:none}
|
|
546
|
+
body.filtering .side-mod.empty{display:none}
|
|
547
|
+
body.filtering .side-domain.empty{display:none}
|
|
548
|
+
|
|
549
|
+
/* No-results state */
|
|
550
|
+
.no-results{
|
|
551
|
+
display:none;text-align:center;padding:40px 20px;color:var(--ink-3);
|
|
552
|
+
}
|
|
553
|
+
.no-results h3{margin:0 0 8px;color:var(--ink);font-weight:600}
|
|
554
|
+
body.filtering.no-match .no-results{display:block}
|
|
555
|
+
body.filtering.no-match section.module{display:none}
|
|
556
|
+
|
|
557
|
+
/* Print — light theme always (saves ink on paper) */
|
|
558
|
+
@media print{
|
|
559
|
+
:root, [data-theme="dark"]{
|
|
560
|
+
--brand:#ed2e26; --ink:#0f172a; --ink-2:#334155; --ink-3:#64748b;
|
|
561
|
+
--line:#e2e8f0; --line-2:#f1f5f9; --bg:#ffffff; --surface:#ffffff;
|
|
562
|
+
--surface-2:#f8fafc; --code-bg:#f5f5f5; --code-fg:#1a1a1a;
|
|
563
|
+
}
|
|
564
|
+
.sidebar, .topbar, .copy-btn, .filter-box{display:none}
|
|
565
|
+
.app{display:block}
|
|
566
|
+
body{background:#fff;color:#000}
|
|
567
|
+
section.module, section.card{box-shadow:none;break-inside:avoid;border-color:#ccc}
|
|
568
|
+
.opts-toggle[open] > summary{display:none}
|
|
569
|
+
.opts-toggle > .opts-list{display:flex !important}
|
|
570
|
+
.cmd-eg{background:#f5f5f5;color:#1a1a1a}
|
|
571
|
+
.cmd-eg .flag{color:#0369a1}
|
|
572
|
+
.cmd-eg .arg{color:#92400e}
|
|
573
|
+
}
|
|
574
|
+
/* Dark-mode-PDF for slide embedding (use ?theme=dark and `print to PDF`) */
|
|
575
|
+
[data-theme="dark"] @media print {
|
|
576
|
+
body{background:#0b1220;color:#e2e8f0}
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
/* Responsive: collapse sidebar at narrow widths */
|
|
580
|
+
@media (max-width:960px){
|
|
581
|
+
.app{grid-template-columns:1fr}
|
|
582
|
+
aside.sidebar{
|
|
583
|
+
position:fixed;left:0;top:0;height:100vh;width:296px;z-index:60;
|
|
584
|
+
transform:translateX(-100%);transition:transform .25s;
|
|
585
|
+
box-shadow:var(--shadow-md);
|
|
586
|
+
}
|
|
587
|
+
body.nav-open aside.sidebar{transform:translateX(0)}
|
|
588
|
+
body.nav-open::before{
|
|
589
|
+
content:"";position:fixed;inset:0;z-index:55;
|
|
590
|
+
background:rgba(0,0,0,.4);
|
|
591
|
+
}
|
|
592
|
+
.topbar .menu-toggle{display:inline-flex}
|
|
593
|
+
.wrap{padding:24px 18px 40px}
|
|
594
|
+
.module-head, .module-body{padding-left:18px;padding-right:18px}
|
|
595
|
+
.module-toc{padding:14px 18px}
|
|
596
|
+
.topbar{padding:0 18px}
|
|
597
|
+
section.card{padding:18px 20px}
|
|
598
|
+
.hero-top{padding:20px 22px}
|
|
599
|
+
.hero-stats{padding:14px 22px}
|
|
600
|
+
}
|
|
601
|
+
.menu-toggle{
|
|
602
|
+
display:none;border:1px solid var(--line);background:var(--surface);
|
|
603
|
+
color:var(--ink-2);padding:6px 10px;border-radius:var(--radius-sm);
|
|
604
|
+
cursor:pointer;font-size:.85rem;align-items:center;gap:6px;
|
|
605
|
+
}
|
|
606
|
+
</style>
|
|
607
|
+
</head>
|
|
608
|
+
<body>
|
|
609
|
+
|
|
610
|
+
<div class="app">
|
|
611
|
+
|
|
612
|
+
<aside class="sidebar" aria-label="Documentation navigation">
|
|
613
|
+
<div class="side-header">
|
|
614
|
+
<img src="https://ik.imagekit.io/qualys/image/logo/qualys.svg" alt="Qualys">
|
|
615
|
+
<span class="ver">v0.1.0</span>
|
|
616
|
+
</div>
|
|
617
|
+
<div class="side-search">
|
|
618
|
+
<input type="search" id="filter" placeholder="Search commands…"
|
|
619
|
+
autocomplete="off" spellcheck="false" aria-label="Search commands">
|
|
620
|
+
<span class="kbd">/</span>
|
|
621
|
+
</div>
|
|
622
|
+
<div class="side-tree" id="side-tree">
|
|
623
|
+
<a class="side-link" href="#getting-started">Getting started</a>
|
|
624
|
+
<a class="side-link" href="#global-flags">Global flags & modes</a>
|
|
625
|
+
<a class="side-link" href="#security">Security & resiliency</a>
|
|
626
|
+
<a class="side-link" href="#mcp-setup">MCP & integrations</a>
|
|
627
|
+
<div class="side-domain">Vulnerability & Compliance</div>
|
|
628
|
+
<details class="side-mod" data-mod="vm"><summary class="side-mod-sum"><span class="side-mod-badge">VM</span><span class="side-mod-title">Vulnerability Management</span><span class="side-mod-count">17</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-vm-scan"><span>scan</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-scan-list" data-search="vm scan list">vm scan list</a><a class="side-cmd" href="#cmd-vm-scan-launch" data-search="vm scan launch">vm scan launch</a><a class="side-cmd" href="#cmd-vm-scan-cancel" data-search="vm scan cancel">vm scan cancel</a><a class="side-cmd" href="#cmd-vm-scan-fetch" data-search="vm scan fetch">vm scan fetch</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-host"><span>host</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-host-list" data-search="vm host list">vm host list</a><a class="side-cmd" href="#cmd-vm-host-detection" data-search="vm host detection">vm host detection</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-kb"><span>kb</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-kb-list" data-search="vm kb list">vm kb list</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-option-profile"><span>option-profile</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-option-profile-list" data-search="vm option-profile list">vm option-profile list</a><a class="side-cmd" href="#cmd-vm-option-profile-create" data-search="vm option-profile create">vm option-profile create</a><a class="side-cmd" href="#cmd-vm-option-profile-delete" data-search="vm option-profile delete">vm option-profile delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-report"><span>report</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-report-list" data-search="vm report list">vm report list</a><a class="side-cmd" href="#cmd-vm-report-launch" data-search="vm report launch">vm report launch</a><a class="side-cmd" href="#cmd-vm-report-fetch" data-search="vm report fetch">vm report fetch</a><a class="side-cmd" href="#cmd-vm-report-delete" data-search="vm report delete">vm report delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-scan-schedule"><span>scan-schedule</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-scan-schedule-list" data-search="vm scan-schedule list">vm scan-schedule list</a><a class="side-cmd" href="#cmd-vm-scan-schedule-delete" data-search="vm scan-schedule delete">vm scan-schedule delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-vm-appliance"><span>appliance</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-vm-appliance-list" data-search="vm appliance list">vm appliance list</a></div></div></div></details>
|
|
629
|
+
<details class="side-mod" data-mod="pc"><summary class="side-mod-sum"><span class="side-mod-badge">PC</span><span class="side-mod-title">Policy Compliance</span><span class="side-mod-count">8</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-pc-scan"><span>scan</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pc-scan-list" data-search="pc scan list">pc scan list</a><a class="side-cmd" href="#cmd-pc-scan-launch" data-search="pc scan launch">pc scan launch</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pc-scan-schedule"><span>scan-schedule</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pc-scan-schedule-list" data-search="pc scan-schedule list">pc scan-schedule list</a><a class="side-cmd" href="#cmd-pc-scan-schedule-delete" data-search="pc scan-schedule delete">pc scan-schedule delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pc-policy"><span>policy</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pc-policy-list" data-search="pc policy list">pc policy list</a><a class="side-cmd" href="#cmd-pc-policy-export" data-search="pc policy export">pc policy export</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pc-posture"><span>posture</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pc-posture-list" data-search="pc posture list">pc posture list</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pc-option-profile"><span>option-profile</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pc-option-profile-list" data-search="pc option-profile list">pc option-profile list</a></div></div></div></details>
|
|
630
|
+
<details class="side-mod" data-mod="was"><summary class="side-mod-sum"><span class="side-mod-badge">WAS</span><span class="side-mod-title">Web Application Scanning</span><span class="side-mod-count">60</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-was-webapp"><span>webapp</span><span class="side-grp-count">7</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-webapp-list" data-search="was webapp list">was webapp list</a><a class="side-cmd" href="#cmd-was-webapp-get" data-search="was webapp get">was webapp get</a><a class="side-cmd" href="#cmd-was-webapp-count" data-search="was webapp count">was webapp count</a><a class="side-cmd" href="#cmd-was-webapp-create" data-search="was webapp create">was webapp create</a><a class="side-cmd" href="#cmd-was-webapp-update" data-search="was webapp update">was webapp update</a><a class="side-cmd" href="#cmd-was-webapp-delete" data-search="was webapp delete">was webapp delete</a><a class="side-cmd" href="#cmd-was-webapp-purge" data-search="was webapp purge">was webapp purge</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-scan"><span>scan</span><span class="side-grp-count">9</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-scan-list" data-search="was scan list">was scan list</a><a class="side-cmd" href="#cmd-was-scan-get" data-search="was scan get">was scan get</a><a class="side-cmd" href="#cmd-was-scan-count" data-search="was scan count">was scan count</a><a class="side-cmd" href="#cmd-was-scan-status" data-search="was scan status">was scan status</a><a class="side-cmd" href="#cmd-was-scan-launch" data-search="was scan launch">was scan launch</a><a class="side-cmd" href="#cmd-was-scan-cancel" data-search="was scan cancel">was scan cancel</a><a class="side-cmd" href="#cmd-was-scan-results" data-search="was scan results">was scan results</a><a class="side-cmd" href="#cmd-was-scan-delete" data-search="was scan delete">was scan delete</a><a class="side-cmd" href="#cmd-was-scan-scan-again" data-search="was scan scan-again">was scan scan-again</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-finding"><span>finding</span><span class="side-grp-count">9</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-finding-list" data-search="was finding list">was finding list</a><a class="side-cmd" href="#cmd-was-finding-get" data-search="was finding get">was finding get</a><a class="side-cmd" href="#cmd-was-finding-count" data-search="was finding count">was finding count</a><a class="side-cmd" href="#cmd-was-finding-ignore" data-search="was finding ignore">was finding ignore</a><a class="side-cmd" href="#cmd-was-finding-reactivate" data-search="was finding reactivate">was finding reactivate</a><a class="side-cmd" href="#cmd-was-finding-restore" data-search="was finding restore">was finding restore</a><a class="side-cmd" href="#cmd-was-finding-retest" data-search="was finding retest">was finding retest</a><a class="side-cmd" href="#cmd-was-finding-retest-status" data-search="was finding retest-status">was finding retest-status</a><a class="side-cmd" href="#cmd-was-finding-edit-severity" data-search="was finding edit-severity">was finding edit-severity</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-auth-record"><span>auth-record</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-auth-record-list" data-search="was auth-record list">was auth-record list</a><a class="side-cmd" href="#cmd-was-auth-record-get" data-search="was auth-record get">was auth-record get</a><a class="side-cmd" href="#cmd-was-auth-record-count" data-search="was auth-record count">was auth-record count</a><a class="side-cmd" href="#cmd-was-auth-record-delete" data-search="was auth-record delete">was auth-record delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-option-profile"><span>option-profile</span><span class="side-grp-count">5</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-option-profile-list" data-search="was option-profile list">was option-profile list</a><a class="side-cmd" href="#cmd-was-option-profile-get" data-search="was option-profile get">was option-profile get</a><a class="side-cmd" href="#cmd-was-option-profile-count" data-search="was option-profile count">was option-profile count</a><a class="side-cmd" href="#cmd-was-option-profile-create" data-search="was option-profile create">was option-profile create</a><a class="side-cmd" href="#cmd-was-option-profile-delete" data-search="was option-profile delete">was option-profile delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-schedule"><span>schedule</span><span class="side-grp-count">7</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-schedule-list" data-search="was schedule list">was schedule list</a><a class="side-cmd" href="#cmd-was-schedule-get" data-search="was schedule get">was schedule get</a><a class="side-cmd" href="#cmd-was-schedule-count" data-search="was schedule count">was schedule count</a><a class="side-cmd" href="#cmd-was-schedule-create" data-search="was schedule create">was schedule create</a><a class="side-cmd" href="#cmd-was-schedule-activate" data-search="was schedule activate">was schedule activate</a><a class="side-cmd" href="#cmd-was-schedule-deactivate" data-search="was schedule deactivate">was schedule deactivate</a><a class="side-cmd" href="#cmd-was-schedule-delete" data-search="was schedule delete">was schedule delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-report"><span>report</span><span class="side-grp-count">8</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-report-list" data-search="was report list">was report list</a><a class="side-cmd" href="#cmd-was-report-get" data-search="was report get">was report get</a><a class="side-cmd" href="#cmd-was-report-status" data-search="was report status">was report status</a><a class="side-cmd" href="#cmd-was-report-count" data-search="was report count">was report count</a><a class="side-cmd" href="#cmd-was-report-create-webapp" data-search="was report create-webapp">was report create-webapp</a><a class="side-cmd" href="#cmd-was-report-create-scan" data-search="was report create-scan">was report create-scan</a><a class="side-cmd" href="#cmd-was-report-download" data-search="was report download">was report download</a><a class="side-cmd" href="#cmd-was-report-delete" data-search="was report delete">was report delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-catalog"><span>catalog</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-catalog-list" data-search="was catalog list">was catalog list</a><a class="side-cmd" href="#cmd-was-catalog-count" data-search="was catalog count">was catalog count</a><a class="side-cmd" href="#cmd-was-catalog-add-to-subscription" data-search="was catalog add-to-subscription">was catalog add-to-subscription</a><a class="side-cmd" href="#cmd-was-catalog-delete" data-search="was catalog delete">was catalog delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-dns"><span>dns</span><span class="side-grp-count">5</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-dns-list" data-search="was dns list">was dns list</a><a class="side-cmd" href="#cmd-was-dns-get" data-search="was dns get">was dns get</a><a class="side-cmd" href="#cmd-was-dns-count" data-search="was dns count">was dns count</a><a class="side-cmd" href="#cmd-was-dns-create" data-search="was dns create">was dns create</a><a class="side-cmd" href="#cmd-was-dns-delete" data-search="was dns delete">was dns delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-was-import"><span>import</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-was-import-burp" data-search="was import burp">was import burp</a><a class="side-cmd" href="#cmd-was-import-owasp-zap" data-search="was import owasp-zap">was import owasp-zap</a></div></div></div></details>
|
|
631
|
+
<div class="side-domain">Cloud Security</div>
|
|
632
|
+
<details class="side-mod" data-mod="tc"><summary class="side-mod-sum"><span class="side-mod-badge">TC</span><span class="side-mod-title">TotalCloud (CSPM)</span><span class="side-mod-count">15</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-tc-connector"><span>connector</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-connector-list" data-search="tc connector list">tc connector list</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-evaluation"><span>evaluation</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-evaluation-list" data-search="tc evaluation list">tc evaluation list</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-report"><span>report</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-report-list" data-search="tc report list">tc report list</a><a class="side-cmd" href="#cmd-tc-report-create" data-search="tc report create">tc report create</a><a class="side-cmd" href="#cmd-tc-report-download" data-search="tc report download">tc report download</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-rule"><span>rule</span><span class="side-grp-count">5</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-rule-list" data-search="tc rule list">tc rule list</a><a class="side-cmd" href="#cmd-tc-rule-create" data-search="tc rule create">tc rule create</a><a class="side-cmd" href="#cmd-tc-rule-enable" data-search="tc rule enable">tc rule enable</a><a class="side-cmd" href="#cmd-tc-rule-disable" data-search="tc rule disable">tc rule disable</a><a class="side-cmd" href="#cmd-tc-rule-delete" data-search="tc rule delete">tc rule delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-exception"><span>exception</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-exception-list" data-search="tc exception list">tc exception list</a><a class="side-cmd" href="#cmd-tc-exception-delete" data-search="tc exception delete">tc exception delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-iac"><span>iac</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-iac-list" data-search="tc iac list">tc iac list</a><a class="side-cmd" href="#cmd-tc-iac-get" data-search="tc iac get">tc iac get</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-tc-cdr"><span>cdr</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-tc-cdr-findings" data-search="tc cdr findings">tc cdr findings</a></div></div></div></details>
|
|
633
|
+
<details class="side-mod" data-mod="ca"><summary class="side-mod-sum"><span class="side-mod-badge">CA</span><span class="side-mod-title">Cloud Agent</span><span class="side-mod-count">15</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-ca-agent"><span>agent</span><span class="side-grp-count">7</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-ca-agent-list" data-search="ca agent list">ca agent list</a><a class="side-cmd" href="#cmd-ca-agent-count" data-search="ca agent count">ca agent count</a><a class="side-cmd" href="#cmd-ca-agent-activate" data-search="ca agent activate">ca agent activate</a><a class="side-cmd" href="#cmd-ca-agent-deactivate" data-search="ca agent deactivate">ca agent deactivate</a><a class="side-cmd" href="#cmd-ca-agent-uninstall" data-search="ca agent uninstall">ca agent uninstall</a><a class="side-cmd" href="#cmd-ca-agent-bulk-activate" data-search="ca agent bulk-activate">ca agent bulk-activate</a><a class="side-cmd" href="#cmd-ca-agent-bulk-deactivate" data-search="ca agent bulk-deactivate">ca agent bulk-deactivate</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-ca-scan"><span>scan</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-ca-scan-launch-ods" data-search="ca scan launch-ods">ca scan launch-ods</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-ca-act-key"><span>act-key</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-ca-act-key-list" data-search="ca act-key list">ca act-key list</a><a class="side-cmd" href="#cmd-ca-act-key-get" data-search="ca act-key get">ca act-key get</a><a class="side-cmd" href="#cmd-ca-act-key-create" data-search="ca act-key create">ca act-key create</a><a class="side-cmd" href="#cmd-ca-act-key-delete" data-search="ca act-key delete">ca act-key delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-ca-config"><span>config</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-ca-config-list" data-search="ca config list">ca config list</a><a class="side-cmd" href="#cmd-ca-config-create" data-search="ca config create">ca config create</a><a class="side-cmd" href="#cmd-ca-config-delete" data-search="ca config delete">ca config delete</a></div></div></div></details>
|
|
634
|
+
<details class="side-mod" data-mod="cs"><summary class="side-mod-sum"><span class="side-mod-badge">CS</span><span class="side-mod-title">Container Security</span><span class="side-mod-count">18</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-cs-image"><span>image</span><span class="side-grp-count">5</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cs-image-list" data-search="cs image list">cs image list</a><a class="side-cmd" href="#cmd-cs-image-get" data-search="cs image get">cs image get</a><a class="side-cmd" href="#cmd-cs-image-vulns" data-search="cs image vulns">cs image vulns</a><a class="side-cmd" href="#cmd-cs-image-software" data-search="cs image software">cs image software</a><a class="side-cmd" href="#cmd-cs-image-delete" data-search="cs image delete">cs image delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-cs-container"><span>container</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cs-container-list" data-search="cs container list">cs container list</a><a class="side-cmd" href="#cmd-cs-container-get" data-search="cs container get">cs container get</a><a class="side-cmd" href="#cmd-cs-container-vulns" data-search="cs container vulns">cs container vulns</a><a class="side-cmd" href="#cmd-cs-container-software" data-search="cs container software">cs container software</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-cs-registry"><span>registry</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cs-registry-list" data-search="cs registry list">cs registry list</a><a class="side-cmd" href="#cmd-cs-registry-get" data-search="cs registry get">cs registry get</a><a class="side-cmd" href="#cmd-cs-registry-delete" data-search="cs registry delete">cs registry delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-cs-sensor"><span>sensor</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cs-sensor-list" data-search="cs sensor list">cs sensor list</a><a class="side-cmd" href="#cmd-cs-sensor-get" data-search="cs sensor get">cs sensor get</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-cs-report"><span>report</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cs-report-list" data-search="cs report list">cs report list</a><a class="side-cmd" href="#cmd-cs-report-create" data-search="cs report create">cs report create</a><a class="side-cmd" href="#cmd-cs-report-download" data-search="cs report download">cs report download</a><a class="side-cmd" href="#cmd-cs-report-delete" data-search="cs report delete">cs report delete</a></div></div></div></details>
|
|
635
|
+
<details class="side-mod" data-mod="csam"><summary class="side-mod-sum"><span class="side-mod-badge">CSAM</span><span class="side-mod-title">CyberSecurity Asset Management</span><span class="side-mod-count">27</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-csam-asset"><span>asset</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-asset-count" data-search="csam asset count">csam asset count</a><a class="side-cmd" href="#cmd-csam-asset-list" data-search="csam asset list">csam asset list</a><a class="side-cmd" href="#cmd-csam-asset-get" data-search="csam asset get">csam asset get</a><a class="side-cmd" href="#cmd-csam-asset-sn-export" data-search="csam asset sn-export">csam asset sn-export</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-easm"><span>easm</span><span class="side-grp-count">9</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-easm-list" data-search="csam easm list">csam easm list</a><a class="side-cmd" href="#cmd-csam-easm-create" data-search="csam easm create">csam easm create</a><a class="side-cmd" href="#cmd-csam-easm-update" data-search="csam easm update">csam easm update</a><a class="side-cmd" href="#cmd-csam-easm-delete" data-search="csam easm delete">csam easm delete</a><a class="side-cmd" href="#cmd-csam-easm-activate" data-search="csam easm activate">csam easm activate</a><a class="side-cmd" href="#cmd-csam-easm-deactivate" data-search="csam easm deactivate">csam easm deactivate</a><a class="side-cmd" href="#cmd-csam-easm-orgs" data-search="csam easm orgs">csam easm orgs</a><a class="side-cmd" href="#cmd-csam-easm-status" data-search="csam easm status">csam easm status</a><a class="side-cmd" href="#cmd-csam-easm-patch" data-search="csam easm patch">csam easm patch</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-vuln"><span>vuln</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-vuln-list-easm" data-search="csam vuln list-easm">csam vuln list-easm</a><a class="side-cmd" href="#cmd-csam-vuln-list-scan" data-search="csam vuln list-scan">csam vuln list-scan</a><a class="side-cmd" href="#cmd-csam-vuln-data" data-search="csam vuln data">csam vuln data</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-domain"><span>domain</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-domain-list" data-search="csam domain list">csam domain list</a><a class="side-cmd" href="#cmd-csam-domain-count" data-search="csam domain count">csam domain count</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-report"><span>report</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-report-create" data-search="csam report create">csam report create</a><a class="side-cmd" href="#cmd-csam-report-download" data-search="csam report download">csam report download</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-component"><span>component</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-component-list" data-search="csam component list">csam component list</a><a class="side-cmd" href="#cmd-csam-component-list-by-asset" data-search="csam component list-by-asset">csam component list-by-asset</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-business"><span>business</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-business-import-asset" data-search="csam business import-asset">csam business import-asset</a><a class="side-cmd" href="#cmd-csam-business-import-app" data-search="csam business import-app">csam business import-app</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-connector"><span>connector</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-connector-sync" data-search="csam connector sync">csam connector sync</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-csam-org"><span>org</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-csam-org-list" data-search="csam org list">csam org list</a><a class="side-cmd" href="#cmd-csam-org-count" data-search="csam org count">csam org count</a></div></div></div></details>
|
|
636
|
+
<div class="side-domain">Patch & Risk</div>
|
|
637
|
+
<details class="side-mod" data-mod="pm"><summary class="side-mod-sum"><span class="side-mod-badge">PM</span><span class="side-mod-title">Patch Management</span><span class="side-mod-count">19</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-pm-job"><span>job</span><span class="side-grp-count">8</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pm-job-list" data-search="pm job list">pm job list</a><a class="side-cmd" href="#cmd-pm-job-get" data-search="pm job get">pm job get</a><a class="side-cmd" href="#cmd-pm-job-create" data-search="pm job create">pm job create</a><a class="side-cmd" href="#cmd-pm-job-update" data-search="pm job update">pm job update</a><a class="side-cmd" href="#cmd-pm-job-delete" data-search="pm job delete">pm job delete</a><a class="side-cmd" href="#cmd-pm-job-change-status" data-search="pm job change-status">pm job change-status</a><a class="side-cmd" href="#cmd-pm-job-runs" data-search="pm job runs">pm job runs</a><a class="side-cmd" href="#cmd-pm-job-summary" data-search="pm job summary">pm job summary</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pm-mitigation"><span>mitigation</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pm-mitigation-list" data-search="pm mitigation list">pm mitigation list</a><a class="side-cmd" href="#cmd-pm-mitigation-create" data-search="pm mitigation create">pm mitigation create</a><a class="side-cmd" href="#cmd-pm-mitigation-delete" data-search="pm mitigation delete">pm mitigation delete</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pm-patch"><span>patch</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pm-patch-list" data-search="pm patch list">pm patch list</a><a class="side-cmd" href="#cmd-pm-patch-count" data-search="pm patch count">pm patch count</a><a class="side-cmd" href="#cmd-pm-patch-products" data-search="pm patch products">pm patch products</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pm-report"><span>report</span><span class="side-grp-count">4</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pm-report-list" data-search="pm report list">pm report list</a><a class="side-cmd" href="#cmd-pm-report-generate" data-search="pm report generate">pm report generate</a><a class="side-cmd" href="#cmd-pm-report-download" data-search="pm report download">pm report download</a><a class="side-cmd" href="#cmd-pm-report-columns" data-search="pm report columns">pm report columns</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-pm-asset"><span>asset</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-pm-asset-list" data-search="pm asset list">pm asset list</a></div></div></div></details>
|
|
638
|
+
<details class="side-mod" data-mod="etm"><summary class="side-mod-sum"><span class="side-mod-badge">ETM</span><span class="side-mod-title">Enterprise TruRisk Management</span><span class="side-mod-count">7</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-etm-report"><span>report</span><span class="side-grp-count">7</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-etm-report-list" data-search="etm report list">etm report list</a><a class="side-cmd" href="#cmd-etm-report-create" data-search="etm report create">etm report create</a><a class="side-cmd" href="#cmd-etm-report-get" data-search="etm report get">etm report get</a><a class="side-cmd" href="#cmd-etm-report-download" data-search="etm report download">etm report download</a><a class="side-cmd" href="#cmd-etm-report-download-resource" data-search="etm report download-resource">etm report download-resource</a><a class="side-cmd" href="#cmd-etm-report-delete" data-search="etm report delete">etm report delete</a><a class="side-cmd" href="#cmd-etm-report-bulk-delete" data-search="etm report bulk-delete">etm report bulk-delete</a></div></div></div></details>
|
|
639
|
+
<div class="side-domain">Asset & User Management</div>
|
|
640
|
+
<details class="side-mod" data-mod="asset"><summary class="side-mod-sum"><span class="side-mod-badge">AST</span><span class="side-mod-title">Asset Management</span><span class="side-mod-count">8</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-asset-ip"><span>ip</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-asset-ip-list" data-search="asset ip list">asset ip list</a><a class="side-cmd" href="#cmd-asset-ip-add" data-search="asset ip add">asset ip add</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-asset-network"><span>network</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-asset-network-list" data-search="asset network list">asset network list</a><a class="side-cmd" href="#cmd-asset-network-create" data-search="asset network create">asset network create</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-asset-domain"><span>domain</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-asset-domain-list" data-search="asset domain list">asset domain list</a><a class="side-cmd" href="#cmd-asset-domain-create" data-search="asset domain create">asset domain create</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-asset-group"><span>group</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-asset-group-list" data-search="asset group list">asset group list</a><a class="side-cmd" href="#cmd-asset-group-delete" data-search="asset group delete">asset group delete</a></div></div></div></details>
|
|
641
|
+
<details class="side-mod" data-mod="scanauth"><summary class="side-mod-sum"><span class="side-mod-badge">SAU</span><span class="side-mod-title">Scan Auth Records</span><span class="side-mod-count">7</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-scanauth-record"><span>record</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-scanauth-record-list" data-search="scanauth record list">scanauth record list</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-scanauth-vault"><span>vault</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-scanauth-vault-list" data-search="scanauth vault list">scanauth vault list</a><a class="side-cmd" href="#cmd-scanauth-vault-create" data-search="scanauth vault create">scanauth vault create</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-scanauth-neo4j"><span>neo4j</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-scanauth-neo4j-list" data-search="scanauth neo4j list">scanauth neo4j list</a><a class="side-cmd" href="#cmd-scanauth-neo4j-create" data-search="scanauth neo4j create">scanauth neo4j create</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-scanauth-nginx"><span>nginx</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-scanauth-nginx-list" data-search="scanauth nginx list">scanauth nginx list</a><a class="side-cmd" href="#cmd-scanauth-nginx-create" data-search="scanauth nginx create">scanauth nginx create</a></div></div></div></details>
|
|
642
|
+
<details class="side-mod" data-mod="user"><summary class="side-mod-sum"><span class="side-mod-badge">USR</span><span class="side-mod-title">User Management</span><span class="side-mod-count">3</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-user-general"><span>general</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-user-list" data-search="user list">user list</a><a class="side-cmd" href="#cmd-user-create" data-search="user create">user create</a><a class="side-cmd" href="#cmd-user-change-password" data-search="user change-password">user change-password</a></div></div></div></details>
|
|
643
|
+
<details class="side-mod" data-mod="sub"><summary class="side-mod-sum"><span class="side-mod-badge">SUB</span><span class="side-mod-title">Subscription Management</span><span class="side-mod-count">5</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-sub-general"><span>general</span><span class="side-grp-count">3</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-sub-info" data-search="sub info">sub info</a><a class="side-cmd" href="#cmd-sub-export" data-search="sub export">sub export</a><a class="side-cmd" href="#cmd-sub-import" data-search="sub import">sub import</a></div></div><div class="side-grp"><a class="side-grp-link" href="#grp-sub-user-prefs"><span>user-prefs</span><span class="side-grp-count">2</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-sub-user-prefs-export" data-search="sub user-prefs export">sub user-prefs export</a><a class="side-cmd" href="#cmd-sub-user-prefs-import" data-search="sub user-prefs import">sub user-prefs import</a></div></div></div></details>
|
|
644
|
+
<div class="side-domain">Operator & Automation</div>
|
|
645
|
+
<details class="side-mod" data-mod="doctor"><summary class="side-mod-sum"><span class="side-mod-badge">DR</span><span class="side-mod-title">Doctor</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-doctor-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-doctor" data-search="doctor">doctor</a></div></div></div></details>
|
|
646
|
+
<details class="side-mod" data-mod="health"><summary class="side-mod-sum"><span class="side-mod-badge">HC</span><span class="side-mod-title">Health probe</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-health-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-health" data-search="health">health</a></div></div></div></details>
|
|
647
|
+
<details class="side-mod" data-mod="stats"><summary class="side-mod-sum"><span class="side-mod-badge">ST</span><span class="side-mod-title">Audit-log analytics</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-stats-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-stats" data-search="stats">stats</a></div></div></div></details>
|
|
648
|
+
<details class="side-mod" data-mod="rotate-jwt"><summary class="side-mod-sum"><span class="side-mod-badge">RJ</span><span class="side-mod-title">Rotate JWT</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-rotate-jwt-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-rotate-jwt" data-search="rotate-jwt">rotate-jwt</a></div></div></div></details>
|
|
649
|
+
<details class="side-mod" data-mod="verify-audit"><summary class="side-mod-sum"><span class="side-mod-badge">VA</span><span class="side-mod-title">Verify audit chain</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-verify-audit-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-verify-audit" data-search="verify-audit">verify-audit</a></div></div></div></details>
|
|
650
|
+
<details class="side-mod" data-mod="last"><summary class="side-mod-sum"><span class="side-mod-badge">LA</span><span class="side-mod-title">Show last response</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-last-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-last" data-search="last">last</a></div></div></div></details>
|
|
651
|
+
<details class="side-mod" data-mod="replay"><summary class="side-mod-sum"><span class="side-mod-badge">RP</span><span class="side-mod-title">Replay by correlation</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-replay-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-replay" data-search="replay">replay</a></div></div></div></details>
|
|
652
|
+
<details class="side-mod" data-mod="watch"><summary class="side-mod-sum"><span class="side-mod-badge">WT</span><span class="side-mod-title">Watch a command</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-watch-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-watch" data-search="watch">watch</a></div></div></div></details>
|
|
653
|
+
<details class="side-mod" data-mod="batch"><summary class="side-mod-sum"><span class="side-mod-badge">BT</span><span class="side-mod-title">Batch runner</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-batch-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-batch" data-search="batch">batch</a></div></div></div></details>
|
|
654
|
+
<details class="side-mod" data-mod="query"><summary class="side-mod-sum"><span class="side-mod-badge">QY</span><span class="side-mod-title">Saved-query library</span><span class="side-mod-count">5</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-query-general"><span>general</span><span class="side-grp-count">5</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-query-list" data-search="query list">query list</a><a class="side-cmd" href="#cmd-query-show" data-search="query show">query show</a><a class="side-cmd" href="#cmd-query-save" data-search="query save">query save</a><a class="side-cmd" href="#cmd-query-delete" data-search="query delete">query delete</a><a class="side-cmd" href="#cmd-query-run" data-search="query run">query run</a></div></div></div></details>
|
|
655
|
+
<details class="side-mod" data-mod="completion"><summary class="side-mod-sum"><span class="side-mod-badge">CO</span><span class="side-mod-title">Shell completion</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-completion-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-completion" data-search="completion">completion</a></div></div></div></details>
|
|
656
|
+
<details class="side-mod" data-mod="cache"><summary class="side-mod-sum"><span class="side-mod-badge">CA</span><span class="side-mod-title">Response cache</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-cache-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-cache-clear" data-search="cache clear">cache clear</a></div></div></div></details>
|
|
657
|
+
<details class="side-mod" data-mod="mcp"><summary class="side-mod-sum"><span class="side-mod-badge">MCP</span><span class="side-mod-title">MCP server</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-mcp-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-mcp" data-search="mcp">mcp</a></div></div></div></details>
|
|
658
|
+
<details class="side-mod" data-mod="serve"><summary class="side-mod-sum"><span class="side-mod-badge">SV</span><span class="side-mod-title">HTTP server</span><span class="side-mod-count">1</span></summary><div class="side-mod-body"><div class="side-grp"><a class="side-grp-link" href="#grp-serve-general"><span>general</span><span class="side-grp-count">1</span></a><div class="side-cmds"><a class="side-cmd" href="#cmd-serve" data-search="serve">serve</a></div></div></div></details>
|
|
659
|
+
</div>
|
|
660
|
+
<div class="side-footer">
|
|
661
|
+
<a href="https://github.com/qualys/qualys-cli" target="_blank" rel="noopener">GitHub</a>
|
|
662
|
+
<span>·</span>
|
|
663
|
+
<a href="#" onclick="window.print();return false;">Print</a>
|
|
664
|
+
</div>
|
|
665
|
+
</aside>
|
|
666
|
+
|
|
667
|
+
<main>
|
|
668
|
+
<div class="topbar">
|
|
669
|
+
<button class="menu-toggle" type="button" aria-label="Toggle navigation"
|
|
670
|
+
onclick="document.body.classList.toggle('nav-open')">☰ Menu</button>
|
|
671
|
+
<nav class="crumbs" id="topcrumb">
|
|
672
|
+
<strong>qualys-cli</strong>
|
|
673
|
+
<span class="crumb-sep">›</span>
|
|
674
|
+
<span>Reference</span>
|
|
675
|
+
</nav>
|
|
676
|
+
<button class="tb-action" type="button" id="density-toggle"
|
|
677
|
+
aria-pressed="false" aria-label="Toggle density">
|
|
678
|
+
Compact
|
|
679
|
+
</button>
|
|
680
|
+
<button class="tb-action" type="button" id="theme-toggle"
|
|
681
|
+
aria-pressed="false" aria-label="Toggle theme">
|
|
682
|
+
Dark
|
|
683
|
+
</button>
|
|
684
|
+
</div>
|
|
685
|
+
|
|
686
|
+
<div class="wrap">
|
|
687
|
+
|
|
688
|
+
<section class="hero" id="getting-started">
|
|
689
|
+
<div class="hero-top">
|
|
690
|
+
<div>
|
|
691
|
+
<h1>qualys-cli<span class="mark">.</span></h1>
|
|
692
|
+
<p>A unified command-line interface for the Qualys Cloud Platform — VM, PC, WAS, TotalCloud, Cloud Agent, Container Security, CSAM, Patch, ETM, and more.</p>
|
|
693
|
+
</div>
|
|
694
|
+
</div>
|
|
695
|
+
<div class="hero-stats">
|
|
696
|
+
<div class="hero-stat"><span class="n">27</span><span class="l">Modules</span></div>
|
|
697
|
+
<div class="hero-stat"><span class="n">227</span><span class="l">Commands</span></div>
|
|
698
|
+
<div class="hero-stat"><span class="n">v0.1.0</span><span class="l">Version</span></div>
|
|
699
|
+
<div class="hero-stat"><span class="n">3.12+</span><span class="l">Python</span></div>
|
|
700
|
+
<div class="hero-stat"><span class="n">MIT</span><span class="l">License</span></div>
|
|
701
|
+
</div>
|
|
702
|
+
</section>
|
|
703
|
+
|
|
704
|
+
<div class="quickstart">
|
|
705
|
+
<div class="qcard">
|
|
706
|
+
<h3><span class="step">1</span> Install</h3>
|
|
707
|
+
<pre>pipx install qualys-cli</pre>
|
|
708
|
+
</div>
|
|
709
|
+
<div class="qcard">
|
|
710
|
+
<h3><span class="step">2</span> Configure</h3>
|
|
711
|
+
<pre>qualys-cli configure</pre>
|
|
712
|
+
</div>
|
|
713
|
+
<div class="qcard">
|
|
714
|
+
<h3><span class="step">3</span> Run</h3>
|
|
715
|
+
<pre>qualys-cli vm host list</pre>
|
|
716
|
+
</div>
|
|
717
|
+
<div class="qcard">
|
|
718
|
+
<h3><span class="step">4</span> Pipe to JSON</h3>
|
|
719
|
+
<pre>qualys-cli mode agentic</pre>
|
|
720
|
+
</div>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
<section class="card" id="global-flags">
|
|
724
|
+
<h2>Global flags & output modes</h2>
|
|
725
|
+
<p class="lead">
|
|
726
|
+
Two persistent output modes govern the default rendering:
|
|
727
|
+
<code>interactive</code> (rich tables, colours, animated cyber-themed
|
|
728
|
+
spinner — the default) and <code>agentic</code> (clean JSON, no
|
|
729
|
+
decoration — best for scripts, CI, and AI agents).
|
|
730
|
+
</p>
|
|
731
|
+
<table class="refs">
|
|
732
|
+
<thead><tr><th>Flag / command</th><th>What it does</th></tr></thead>
|
|
733
|
+
<tbody>
|
|
734
|
+
<tr><td><code>qualys-cli mode</code></td><td>Show current output mode for the active profile</td></tr>
|
|
735
|
+
<tr><td><code>qualys-cli mode agentic</code></td><td>Switch to agentic (JSON) output persistently</td></tr>
|
|
736
|
+
<tr><td><code>qualys-cli mode interactive</code></td><td>Switch back to rich-table output</td></tr>
|
|
737
|
+
<tr><td><code>--format json|jsonl|yaml|table|csv|tsv|markdown</code></td><td>One-shot per-command output override. Note: <code>csv</code>, <code>tsv</code>, and <code>markdown</code> auto-uncap (no 25-row truncation) since they're typically piped to spreadsheets / tickets.</td></tr>
|
|
738
|
+
<tr><td><code>--limit 0</code></td><td>Remove the default 25-row table cap (table format only — exports already uncap automatically)</td></tr>
|
|
739
|
+
<tr><td><code>--output-file results.json</code></td><td>Dump full data to a file (JSON / YAML / CSV / NDJSON by extension)</td></tr>
|
|
740
|
+
<tr><td><code>--where field=value</code> · <code>field!=v</code> · <code>field~regex</code> · <code>field>=N</code> · <code>field>N</code> · <code>field<=N</code> · <code>field<N</code></td><td>Post-filter rows after extraction. Numeric coercion when both sides parse as numbers; field names match case-insensitively (e.g. <code>severity</code> matches <code>SEVERITY</code>).</td></tr>
|
|
741
|
+
<tr><td><code>--columns name,id,status</code></td><td>Override default table columns</td></tr>
|
|
742
|
+
<tr><td><code>--sort field[:asc|:desc]</code> · <code>--sort-by FIELD [--sort-desc]</code></td><td>Sort rows in memory (case-insensitive field match). <code>--sort</code> is the terse form; <code>--sort-by</code> + <code>--sort-desc</code> is the verbose pair.</td></tr>
|
|
743
|
+
<tr><td><code>--jq '.path[].name'</code></td><td>jq-lite expression on the parsed payload (dotted keys, <code>[]</code> flatten, <code>[N]</code> index)</td></tr>
|
|
744
|
+
<tr><td><code>--dry-run</code> / <code>--explain</code></td><td>Print the resolved HTTP request and exit (no network I/O)</td></tr>
|
|
745
|
+
<tr><td><code>-v</code> / <code>-vv</code></td><td>Log requests and response sizes; secrets and Authorization headers redacted</td></tr>
|
|
746
|
+
<tr><td><code>--profile NAME</code></td><td>Select a named credential profile</td></tr>
|
|
747
|
+
<tr><td><code>--version</code> / <code>-V</code></td><td>Print version and exit</td></tr>
|
|
748
|
+
<tr><td><code>QUALYS_OUTPUT_MODE=agentic</code></td><td>Per-shell override for output mode</td></tr>
|
|
749
|
+
<tr><td><code>QUALYS_PROFILE=NAME</code></td><td>Per-shell profile override</td></tr>
|
|
750
|
+
<tr><td><code>QUALYS_URL</code> / <code>QUALYS_GATEWAY_URL</code></td><td>Override platform / gateway URLs (otherwise auto-detected)</td></tr>
|
|
751
|
+
<tr><td><code>QUALYS_USERNAME</code> / <code>QUALYS_PASSWORD</code></td><td>Per-shell credential override (no keyring write)</td></tr>
|
|
752
|
+
<tr><td><code>QUALYS_AUDIT_LOG=off</code></td><td>Disable audit logging for the current shell</td></tr>
|
|
753
|
+
<tr><td><code>QUALYS_AUDIT_FSYNC=1</code></td><td>fsync() each audit line (SIEM-grade durability)</td></tr>
|
|
754
|
+
<tr><td><code>QUALYS_AUDIT_HMAC=0</code></td><td>Disable tamper-evident HMAC chaining</td></tr>
|
|
755
|
+
<tr><td><code>QUALYS_TIMEOUT</code> / <code>QUALYS_CONNECT_TIMEOUT</code></td><td>Per-call timeouts (seconds)</td></tr>
|
|
756
|
+
<tr><td><code>QUALYS_MAX_RETRIES</code></td><td>Retry attempts (default 4)</td></tr>
|
|
757
|
+
<tr><td><code>QUALYS_BACKOFF_BASE</code> / <code>QUALYS_BACKOFF_CAP</code></td><td>Tune full-jitter backoff window</td></tr>
|
|
758
|
+
<tr><td><code>QUALYS_BODY_LIMIT_BYTES</code></td><td>Refuse responses larger than N bytes (default 250 MB)</td></tr>
|
|
759
|
+
<tr><td><code>QUALYS_NO_FLAIR=1</code></td><td>Disable the cyber-themed cycling spinner</td></tr>
|
|
760
|
+
<tr><td><code>QUALYS_CACHE=off</code> / <code>QUALYS_CACHE_TTL</code></td><td>Control the ETag-aware response cache</td></tr>
|
|
761
|
+
</tbody>
|
|
762
|
+
</table>
|
|
763
|
+
</section>
|
|
764
|
+
|
|
765
|
+
<section class="card" id="security">
|
|
766
|
+
<h2>Security & resiliency</h2>
|
|
767
|
+
<p class="lead">
|
|
768
|
+
Every call is wrapped in retry-with-jitter, audit logging with
|
|
769
|
+
correlation IDs, and a typed exception hierarchy with deterministic
|
|
770
|
+
exit codes. Secrets never reach disk, logs, or stderr.
|
|
771
|
+
</p>
|
|
772
|
+
<div class="feat-grid">
|
|
773
|
+
<div class="feat">
|
|
774
|
+
<div class="feat-h"><span class="feat-icon"></span>Credential storage</div>
|
|
775
|
+
<p>Passwords stored in the OS keyring (macOS Keychain / Linux Secret Service / Windows Credential Manager). Config file is <code>0600</code>.</p>
|
|
776
|
+
</div>
|
|
777
|
+
<div class="feat">
|
|
778
|
+
<div class="feat-h"><span class="feat-icon"></span>Secret redaction</div>
|
|
779
|
+
<p>Argv, query strings, request bodies, and verbose logs are scrubbed before any persistence. JWT tokens are summarised as a stable <code>jwt:<sha256-prefix></code> fingerprint.</p>
|
|
780
|
+
</div>
|
|
781
|
+
<div class="feat">
|
|
782
|
+
<div class="feat-h"><span class="feat-icon"></span>Audit log (JSONL, HMAC-chained)</div>
|
|
783
|
+
<p>Default <code>~/.config/qualys-cli/audit.log</code>. One JSON object per lifecycle event and HTTP call, each cryptographically chained to the previous via HMAC-SHA-256. <code>qualys-cli verify-audit</code> detects tampering. Size-rotates at 10 MB.</p>
|
|
784
|
+
</div>
|
|
785
|
+
<div class="feat">
|
|
786
|
+
<div class="feat-h"><span class="feat-icon"></span>Correlation IDs</div>
|
|
787
|
+
<p>Each invocation gets one <code>X-Correlation-ID</code>; each attempt gets an <code>X-Request-ID</code>. Both are sent on the wire and stamped into every audit and error record.</p>
|
|
788
|
+
</div>
|
|
789
|
+
<div class="feat">
|
|
790
|
+
<div class="feat-h"><span class="feat-icon"></span>Retry & backoff</div>
|
|
791
|
+
<p>Full-jitter exponential backoff on 408, 425, 429, 500, 502, 503, 504, and transport errors. Honours <code>Retry-After</code> on 429/503. JWT auto-refreshes on 401 without consuming the retry budget.</p>
|
|
792
|
+
</div>
|
|
793
|
+
<div class="feat">
|
|
794
|
+
<div class="feat-h"><span class="feat-icon"></span>Typed errors</div>
|
|
795
|
+
<p>Auth, NotFound, RateLimit, Timeout, Network, Server, Configuration — each with a distinct exit code (<code>3</code>, <code>4</code>, <code>5</code>, <code>6</code>, <code>6</code>, <code>7</code>, <code>2</code>) and a closed-set <code>type</code> in the JSON error payload.</p>
|
|
796
|
+
</div>
|
|
797
|
+
<div class="feat">
|
|
798
|
+
<div class="feat-h"><span class="feat-icon"></span>Tunables</div>
|
|
799
|
+
<p>Override timeouts and retry behaviour via env: <code>QUALYS_TIMEOUT</code>, <code>QUALYS_CONNECT_TIMEOUT</code>, <code>QUALYS_MAX_RETRIES</code>, <code>QUALYS_BACKOFF_BASE</code>, <code>QUALYS_BACKOFF_CAP</code>, <code>QUALYS_MAX_CONNECTIONS</code>, <code>QUALYS_MAX_KEEPALIVE</code>.</p>
|
|
800
|
+
</div>
|
|
801
|
+
<div class="feat">
|
|
802
|
+
<div class="feat-h"><span class="feat-icon"></span>Defensive defaults</div>
|
|
803
|
+
<p>Destructive operations require <code>--yes</code>. No telemetry. No update checks. The only outbound traffic is to the configured Qualys platform URL.</p>
|
|
804
|
+
</div>
|
|
805
|
+
<div class="feat">
|
|
806
|
+
<div class="feat-h"><span class="feat-icon"></span>Idempotent retries</div>
|
|
807
|
+
<p>Only GET / HEAD / DELETE retry by default; POST / PUT / PATCH require explicit opt-in to avoid silent double-submits (<code>vm scan launch</code> never fires twice). Read-shaped <code>/search/</code> POSTs are auto-detected.</p>
|
|
808
|
+
</div>
|
|
809
|
+
<div class="feat">
|
|
810
|
+
<div class="feat-h"><span class="feat-icon"></span>Scope-restricted profiles</div>
|
|
811
|
+
<p><code>allowed_modules</code> in a profile pins it to a subset of API surfaces (e.g. analyst account → <code>vm</code> only). Out-of-scope commands are refused before any HTTP call.</p>
|
|
812
|
+
</div>
|
|
813
|
+
<div class="feat">
|
|
814
|
+
<div class="feat-h"><span class="feat-icon"></span>PII redaction</div>
|
|
815
|
+
<p><code>redact_fields</code> in a profile scrubs response payloads before rendering — name, email, ssn, etc. Mirrors the existing argv / body redaction so PII never reaches stdout, logs, or files.</p>
|
|
816
|
+
</div>
|
|
817
|
+
<div class="feat">
|
|
818
|
+
<div class="feat-h"><span class="feat-icon"></span>Body-size guard</div>
|
|
819
|
+
<p>Refuses to load > 250 MB into memory unless <code>--output-file</code> streams to disk. Prevents OOM on legacy report exports.</p>
|
|
820
|
+
</div>
|
|
821
|
+
<div class="feat">
|
|
822
|
+
<div class="feat-h"><span class="feat-icon"></span>Connection-error taxonomy</div>
|
|
823
|
+
<p>DNS / TLS / refused / reset / timeout each map to a distinct error class with its own hint, so a misconfigured proxy doesn't masquerade as a credential problem.</p>
|
|
824
|
+
</div>
|
|
825
|
+
<div class="feat">
|
|
826
|
+
<div class="feat-h"><span class="feat-icon"></span>Concurrency safety</div>
|
|
827
|
+
<p>Per-profile JWT-exchange lock so parallel pagination workers don't clobber each other's tokens. Audit-log writes re-resolve the file handle inside the lock so rotation is safe under high call volume.</p>
|
|
828
|
+
</div>
|
|
829
|
+
<div class="feat">
|
|
830
|
+
<div class="feat-h"><span class="feat-icon"></span>Cache hygiene</div>
|
|
831
|
+
<p>The local ETag cache only stores 200 OK responses with non-empty bodies. 304 Not Modified serves the previously-cached body without overwriting it; 4xx / 5xx never poison the cache.</p>
|
|
832
|
+
</div>
|
|
833
|
+
<div class="feat">
|
|
834
|
+
<div class="feat-h"><span class="feat-icon"></span>Read-only preflight</div>
|
|
835
|
+
<p><code>qualys-cli doctor</code> exchanges a fresh JWT to verify credentials but discards it — running doctor on a cron does NOT mutate <code>config.toml</code> or invalidate other workers' cached tokens.</p>
|
|
836
|
+
</div>
|
|
837
|
+
<div class="feat">
|
|
838
|
+
<div class="feat-h"><span class="feat-icon"></span>Bind-anywhere safety</div>
|
|
839
|
+
<p><code>qualys-cli serve</code> refuses non-loopback hosts unless the operator explicitly passes <code>--allow-public-network</code>. The server has no auth on the wire, so this prevents an accidental <code>--host 0.0.0.0</code> from exposing the CLI to the LAN.</p>
|
|
840
|
+
</div>
|
|
841
|
+
<div class="feat">
|
|
842
|
+
<div class="feat-h"><span class="feat-icon"></span>Saved-query safety</div>
|
|
843
|
+
<p>Query names are restricted to <code>[A-Za-z0-9_-]+</code> with a defence-in-depth check that the resolved path stays inside the queries directory. TOML serialisation goes through <code>json.dumps</code> so descriptions / args containing quotes, backslashes, newlines, or Unicode round-trip safely.</p>
|
|
844
|
+
</div>
|
|
845
|
+
</div>
|
|
846
|
+
</section>
|
|
847
|
+
|
|
848
|
+
<section class="card" id="mcp-setup">
|
|
849
|
+
<h2>MCP & integrations — wire qualys-cli into Claude / Cursor / agents</h2>
|
|
850
|
+
<p class="lead">
|
|
851
|
+
<code>qualys-cli mcp</code> runs a Model Context Protocol stdio server.
|
|
852
|
+
Every CLI command is published as an MCP tool whose JSON Schema is
|
|
853
|
+
generated from its option signature, so Claude Desktop, Cursor, and any
|
|
854
|
+
MCP-aware agent can drive the full Qualys API surface natively.
|
|
855
|
+
</p>
|
|
856
|
+
|
|
857
|
+
<h3 style="margin-top:18px;font-size:.92rem">No console output by design</h3>
|
|
858
|
+
<p style="color:var(--ink-3);font-size:.88rem;margin-top:6px">
|
|
859
|
+
MCP servers speak JSON-RPC on <code>stdin</code> / <code>stdout</code>;
|
|
860
|
+
any extra output would corrupt the protocol. So when you run
|
|
861
|
+
<code>qualys-cli mcp</code> in a terminal it just sits silently waiting
|
|
862
|
+
for a client to write a request to <code>stdin</code>. To verify it's
|
|
863
|
+
alive, paste this and press <kbd>Enter</kbd>:
|
|
864
|
+
</p>
|
|
865
|
+
<pre class="cmd-eg" style="margin:8px 0">{"jsonrpc":"2.0","id":1,"method":"initialize","params":{}}</pre>
|
|
866
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
867
|
+
You should see a single JSON line back. <kbd>Ctrl-C</kbd> to exit.
|
|
868
|
+
</p>
|
|
869
|
+
|
|
870
|
+
<h3 style="margin-top:18px;font-size:.92rem">1 · Find the Claude Desktop config file</h3>
|
|
871
|
+
<table class="refs">
|
|
872
|
+
<thead><tr><th>OS</th><th>Path</th></tr></thead>
|
|
873
|
+
<tbody>
|
|
874
|
+
<tr><td>macOS</td><td><code>~/Library/Application Support/Claude/claude_desktop_config.json</code></td></tr>
|
|
875
|
+
<tr><td>Windows</td><td><code>%APPDATA%\Claude\claude_desktop_config.json</code></td></tr>
|
|
876
|
+
<tr><td>Linux</td><td><code>~/.config/Claude/claude_desktop_config.json</code></td></tr>
|
|
877
|
+
</tbody>
|
|
878
|
+
</table>
|
|
879
|
+
|
|
880
|
+
<h3 style="margin-top:18px;font-size:.92rem">2 · Use the absolute path to qualys-cli</h3>
|
|
881
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
882
|
+
Claude Desktop launches MCP servers without a shell, so <code>qualys-cli</code>
|
|
883
|
+
on <code>PATH</code> won't be found. Resolve the absolute path:
|
|
884
|
+
</p>
|
|
885
|
+
<pre class="cmd-eg" style="margin:8px 0">which qualys-cli
|
|
886
|
+
# e.g. /Users/you/.local/bin/qualys-cli (pipx install)
|
|
887
|
+
# /Users/you/repo/.venv/bin/qualys-cli (uv venv)</pre>
|
|
888
|
+
|
|
889
|
+
<h3 style="margin-top:18px;font-size:.92rem">3 · Add to <code>claude_desktop_config.json</code></h3>
|
|
890
|
+
<pre class="cmd-eg" style="margin:8px 0">{
|
|
891
|
+
"mcpServers": {
|
|
892
|
+
"qualys-cli": {
|
|
893
|
+
"command": "/absolute/path/to/qualys-cli",
|
|
894
|
+
"args": ["mcp"],
|
|
895
|
+
"env": {
|
|
896
|
+
"QUALYS_PROFILE": "default",
|
|
897
|
+
"QUALYS_AUDIT_LOG": "/Users/you/.config/qualys-cli/audit.log"
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
}
|
|
901
|
+
}</pre>
|
|
902
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
903
|
+
If you already have other MCP servers, add the
|
|
904
|
+
<code>"qualys-cli": {…}</code> entry alongside them inside the existing
|
|
905
|
+
<code>mcpServers</code> object — don't create a second block.
|
|
906
|
+
</p>
|
|
907
|
+
|
|
908
|
+
<h3 style="margin-top:18px;font-size:.92rem">4 · Fully relaunch Claude Desktop</h3>
|
|
909
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
910
|
+
<kbd>Cmd-Q</kbd> (not just close the window) then reopen. Servers are
|
|
911
|
+
only re-scanned on a full relaunch. In a new chat, click the
|
|
912
|
+
<strong>🔌 tools icon</strong> at the bottom-right of the input box —
|
|
913
|
+
you should see <code>qualys-cli</code> with ~227 tools listed using
|
|
914
|
+
underscore-separated names (<code>vm_host_list</code>,
|
|
915
|
+
<code>csam_asset_list</code>, <code>pm_job_list</code>,
|
|
916
|
+
<code>csam_vuln_list-easm</code>, …). Anthropic's tool-name validator
|
|
917
|
+
requires <code>^[a-zA-Z0-9_-]{1,64}$</code>, so the MCP server uses
|
|
918
|
+
<code>_</code> as the path separator (not <code>.</code>); CLI verbs
|
|
919
|
+
with hyphens such as <code>rotate-jwt</code> are preserved intact.
|
|
920
|
+
</p>
|
|
921
|
+
|
|
922
|
+
<h3 style="margin-top:18px;font-size:.92rem">5 · Troubleshoot via the Claude Desktop logs</h3>
|
|
923
|
+
<pre class="cmd-eg" style="margin:8px 0">tail -f ~/Library/Logs/Claude/mcp*.log</pre>
|
|
924
|
+
<table class="refs">
|
|
925
|
+
<thead><tr><th>Log / error says</th><th>Fix</th></tr></thead>
|
|
926
|
+
<tbody>
|
|
927
|
+
<tr><td><code>spawn qualys-cli ENOENT</code></td><td>Use the absolute path to the binary (step 2).</td></tr>
|
|
928
|
+
<tr><td><code>Error: No username for profile 'default'</code></td><td>Run <code>qualys-cli configure</code> once in a terminal so creds land in the keyring, then relaunch Claude.</td></tr>
|
|
929
|
+
<tr><td><code>JSONDecodeError</code> on first frame</td><td>Something on <code>stdout</code> is corrupting the protocol. Make sure no <code>print()</code> lurks in a startup hook.</td></tr>
|
|
930
|
+
<tr><td><code>EPIPE</code> on shutdown</td><td>Harmless — expected when Claude tears the server down.</td></tr>
|
|
931
|
+
<tr><td><code>tools.N.FrontendRemoteMcpToolDefinition.name: String should match pattern '^[a-zA-Z0-9_-]{1,64}$'</code></td><td>Upgrade <code>qualys-cli</code> — older builds emitted tool names with dots (<code>vm.host.list</code>); current builds use underscores (<code>vm_host_list</code>) which match Anthropic's validator.</td></tr>
|
|
932
|
+
<tr><td>Validator complains about <code>id</code> being null / missing, plus <code>unrecognized_keys: ["error"]</code> on responses</td><td>Upgrade <code>qualys-cli</code> — older builds responded to JSON-RPC notifications (e.g. <code>notifications/initialized</code>) with a method-not-found <code>error</code> frame and <code>id: null</code>, which Anthropic's strict validator rejects. Current builds drop notifications silently and only respond to actual requests.</td></tr>
|
|
933
|
+
</tbody>
|
|
934
|
+
</table>
|
|
935
|
+
|
|
936
|
+
<h3 style="margin-top:18px;font-size:.92rem">Test before wiring Claude Desktop — use the official MCP inspector</h3>
|
|
937
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
938
|
+
Browse the tool catalogue, fire <code>tools/list</code> and
|
|
939
|
+
<code>tools/call</code> interactively, and see every JSON-RPC frame on
|
|
940
|
+
the wire — far easier than tailing logs:
|
|
941
|
+
</p>
|
|
942
|
+
<pre class="cmd-eg" style="margin:8px 0">npx @modelcontextprotocol/inspector qualys-cli mcp</pre>
|
|
943
|
+
|
|
944
|
+
<h3 style="margin-top:18px;font-size:.92rem">Audit trail of MCP-driven calls</h3>
|
|
945
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
946
|
+
The MCP server runs each tool by shelling out to a fresh
|
|
947
|
+
<code>qualys-cli</code> process in agentic mode, so every Claude-driven
|
|
948
|
+
invocation lands in the audit log with its own correlation ID — exactly
|
|
949
|
+
as if a human had typed the command:
|
|
950
|
+
</p>
|
|
951
|
+
<pre class="cmd-eg" style="margin:8px 0">tail -f ~/.config/qualys-cli/audit.log | jq .</pre>
|
|
952
|
+
|
|
953
|
+
<h3 style="margin-top:18px;font-size:.92rem">Cursor & other MCP clients</h3>
|
|
954
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
955
|
+
Cursor's <code>~/.cursor/mcp.json</code> uses the same shape as Claude
|
|
956
|
+
Desktop's config — drop in the identical <code>"qualys-cli"</code>
|
|
957
|
+
entry. Any MCP-aware client (Continue.dev, Cline, Zed AI, custom agents
|
|
958
|
+
via the <code>@modelcontextprotocol/sdk</code> packages) can drive it
|
|
959
|
+
too — the JSON-RPC interface is standard.
|
|
960
|
+
</p>
|
|
961
|
+
|
|
962
|
+
<h3 style="margin-top:18px;font-size:.92rem">Alternative — local HTTP bridge</h3>
|
|
963
|
+
<p style="color:var(--ink-3);font-size:.88rem">
|
|
964
|
+
Prefer REST over MCP? <code>qualys-cli serve</code> boots a localhost
|
|
965
|
+
HTTP server on <code>127.0.0.1:8765</code> with three endpoints:
|
|
966
|
+
<code>GET /</code> (health), <code>GET /tools</code> (catalogue),
|
|
967
|
+
<code>POST /run</code> (invoke a command). Useful for low-code tools,
|
|
968
|
+
Postman collections, and dashboards.
|
|
969
|
+
</p>
|
|
970
|
+
</section>
|
|
971
|
+
|
|
972
|
+
<div class="no-results">
|
|
973
|
+
<h3>No commands match your search</h3>
|
|
974
|
+
<p>Try a shorter term, or press <kbd>Esc</kbd> to clear.</p>
|
|
975
|
+
</div>
|
|
976
|
+
|
|
977
|
+
<section class="module" id="vm"><header class="module-head"><div class="mod-badge">VM</div><div class="mod-title"><h2>Vulnerability Management</h2><p class="mod-sub">Hosts, scans, knowledgebase, option profiles, reports, schedules, scanner appliances</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">17 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-vm-scan">scan<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-vm-host">host<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-vm-kb">kb<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-vm-option-profile">option-profile<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-vm-report">report<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-vm-scan-schedule">scan-schedule<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-vm-appliance">appliance<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-vm-scan"><h3 class="grp-title"><span class="grp-name">scan</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-scan-list" data-search="vm scan list list vm scans." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm scan <span class="verb">list</span></code><p class="cmd-summary">List VM scans.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_scans/list_vm_scans.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan list">qualys-cli vm scan list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--state</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Running|Paused|Cancelled|Finished|Error|Queued|Loading</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Running</code> <code class="chip">Paused</code> <code class="chip">Cancelled</code> <code class="chip">Finished</code> <code class="chip">Error</code> <code class="chip">Queued</code> <code class="chip">Loading</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">On-Demand|Scheduled|API</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">On-Demand</code> <code class="chip">Scheduled</code> <code class="chip">API</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--target</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Target IP/range</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--launched-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Datetime YYYY-MM-DD</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--all</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-scan-launch" data-search="vm scan launch launch a vm scan." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">launch</span></div><code class="cmd-full">qualys-cli vm scan <span class="verb">launch</span></code><p class="cmd-summary">Launch a VM scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_scans/launch_vm_scan.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan launch --title VALUE --ip VALUE">qualys-cli vm scan launch <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--ip</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-cond">+ 2 required (one-of)</span> · <span class="cnt-opt">7 optional</span></summary><div class="opt-note"><strong>One-of required:</strong> <code class="chip">--option-id</code> <code class="chip">--option-title</code> <span class="opt-note-sub">— pass at least one</span></div><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Scan title</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ip</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Target IP(s), ranges or network IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--option-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Option profile ID (required if --option-title not given)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--option-title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Option profile title (required if --option-id not given)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--scanner</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Scanner appliance name(s), comma-separated</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--asset-groups</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Asset group IDs, comma-separated (alternative to --ip)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--asset-group-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Asset group IDs by name, comma-separated</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--priority</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">0 (no priority) – 9 (emergency)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ip-network-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Network ID for the target IPs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-scan-cancel" data-search="vm scan cancel cancel a running scan." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">cancel</span></div><code class="cmd-full">qualys-cli vm scan <span class="verb">cancel</span></code><p class="cmd-summary">Cancel a running scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_scans/manage_vm_scans.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan cancel <scan-ref>">qualys-cli vm scan cancel <span class="arg"><scan-ref></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_REF</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan reference (scan/1234567890.12345)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-scan-fetch" data-search="vm scan fetch fetch scan results (downloads xml to file)." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">fetch</span></div><code class="cmd-full">qualys-cli vm scan <span class="verb">fetch</span></code><p class="cmd-summary">Fetch scan results (downloads XML to file).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_scans/vm_scan_summary.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan fetch <scan-ref>">qualys-cli vm scan fetch <span class="arg"><scan-ref></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_REF</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan reference</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">scan-results.xml</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-host"><h3 class="grp-title"><span class="grp-name">host</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-host-list" data-search="vm host list list hosts in the asset inventory." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">host</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm host <span class="verb">list</span></code><p class="cmd-summary">List hosts in the asset inventory.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/host_lists/host_list.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm host list">qualys-cli vm host list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated IPs or ranges</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ag-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Asset group IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--os</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">OS regex pattern</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--all</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-host-detection" data-search="vm host detection list host vulnerability detections." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">host</span> <span class='crumb-sep'>›</span> <span class="crumb">detection</span></div><code class="cmd-full">qualys-cli vm host <span class="verb">detection</span></code><p class="cmd-summary">List host vulnerability detections.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/host_lists/host_detection.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm host detection">qualys-cli vm host detection</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--qids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated QIDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--severities</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">1-5 comma-separated</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--all</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-kb"><h3 class="grp-title"><span class="grp-name">kb</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-kb-list" data-search="vm kb list list vulnerabilities from the knowledgebase." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">kb</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm kb <span class="verb">list</span></code><p class="cmd-summary">List vulnerabilities from the KnowledgeBase.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/kbase/knowledgebase.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm kb list">qualys-cli vm kb list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-cond">+ 3 required (one-of)</span> · <span class="cnt-opt">16 optional</span></summary><div class="opt-note"><strong>One-of required:</strong> <code class="chip">--id-max</code> <code class="chip">--id-min</code> <code class="chip">--ids</code> <span class="opt-note-sub">— pass at least one</span></div><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Comma-separated QID(s)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--id-min</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Minimum QID in range</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--id-max</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Maximum QID in range</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cve</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated CVE IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--published-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">YYYY-MM-DD[THH:MM:SSZ]</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--published-before</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">YYYY-MM-DD[THH:MM:SSZ]</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-modified-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">YYYY-MM-DD[THH:MM:SSZ]</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-modified-before</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">YYYY-MM-DD[THH:MM:SSZ]</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--details</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Basic|All|None</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Basic</code> <code class="chip">All</code> <code class="chip">None</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--patchable/--not-patchable</code></div><div class="opt-meta-bar"><span class="b-type">BOOLEAN</span></div><div class="opt-body"><div class="opt-help">Filter by whether a patch exists</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--discovery-method</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Remote|Authenticated|RemoteOnly|AuthenticatedOnly|RemoteAndAuthenticated</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Remote</code> <code class="chip">Authenticated</code> <code class="chip">RemoteOnly</code> <code class="chip">AuthenticatedOnly</code> <code class="chip">RemoteAndAuthenticated</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-pci-reasons</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include PCI pass/fail reasons</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-disabled-flag</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include the disabled flag for each QID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-supported-modules-info</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include supported-module info</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-qid-change-log</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include QID change-log entries</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-option-profile"><h3 class="grp-title"><span class="grp-name">option-profile</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-option-profile-list" data-search="vm option-profile list list vm option profiles." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm option-profile <span class="verb">list</span></code><p class="cmd-summary">List VM option profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/ops/ops_vm/VM_Option_Profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm option-profile list">qualys-cli vm option-profile list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title-contains</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-option-profile-create" data-search="vm option-profile create create a vm option profile." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli vm option-profile <span class="verb">create</span></code><p class="cmd-summary">Create a VM option profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/ops/ops_vm/VM_Option_Profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm option-profile create --title VALUE">qualys-cli vm option-profile create <span class="flag">--title</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-option-profile-delete" data-search="vm option-profile delete delete vm option profile(s)." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli vm option-profile <span class="verb">delete</span></code><p class="cmd-summary">Delete VM option profile(s).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/ops/ops_vm/VM_Option_Profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm option-profile delete <ids>">qualys-cli vm option-profile delete <span class="arg"><ids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Option profile ID(s)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-report-list" data-search="vm report list list vm/pc reports." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm report <span class="verb">list</span></code><p class="cmd-summary">List VM/PC reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/reports/reports/list_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm report list">qualys-cli vm report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--state</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Running|Finished|Canceled</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Running</code> <code class="chip">Finished</code> <code class="chip">Canceled</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-report-launch" data-search="vm report launch launch a vm/pc report." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">launch</span></div><code class="cmd-full">qualys-cli vm report <span class="verb">launch</span></code><p class="cmd-summary">Launch a VM/PC report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/reports/reports/launch_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm report launch --template-id VALUE --title VALUE">qualys-cli vm report launch <span class="flag">--template-id</span> <span class="arg">VALUE</span> <span class="flag">--title</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--template-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-format</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">PDF|HTML|XML|CSV|DOCX</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">PDF</code> <code class="chip">HTML</code> <code class="chip">XML</code> <code class="chip">CSV</code> <code class="chip">DOCX</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">PDF</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-report-fetch" data-search="vm report fetch fetch (download) a completed report." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">fetch</span></div><code class="cmd-full">qualys-cli vm report <span class="verb">fetch</span></code><p class="cmd-summary">Fetch (download) a completed report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/reports/reports/fetch_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm report fetch <report-id>">qualys-cli vm report fetch <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">report.pdf</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-report-delete" data-search="vm report delete delete a report." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli vm report <span class="verb">delete</span></code><p class="cmd-summary">Delete a report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/reports/reports/delete_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm report delete <report-id>">qualys-cli vm report delete <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-scan-schedule"><h3 class="grp-title"><span class="grp-name">scan-schedule</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-scan-schedule-list" data-search="vm scan-schedule list list vm scan schedules." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan-schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm scan-schedule <span class="verb">list</span></code><p class="cmd-summary">List VM scan schedules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_schedules/list_scan_schedules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan-schedule list">qualys-cli vm scan-schedule list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--active/--inactive</code></div><div class="opt-meta-bar"><span class="b-type">BOOLEAN</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-vm-scan-schedule-delete" data-search="vm scan-schedule delete delete scan schedule(s)." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">scan-schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli vm scan-schedule <span class="verb">delete</span></code><p class="cmd-summary">Delete scan schedule(s).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/vm_schedules/delete_scan_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm scan-schedule delete <ids>">qualys-cli vm scan-schedule delete <span class="arg"><ids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID(s)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-vm-appliance"><h3 class="grp-title"><span class="grp-name">appliance</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-vm-appliance-list" data-search="vm appliance list list scanner appliances." data-mod="vm"><header class="cmd-head"><div class="crumbs"><span class="crumb">vm</span> <span class='crumb-sep'>›</span> <span class="crumb">appliance</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli vm appliance <span class="verb">list</span></code><p class="cmd-summary">List scanner appliances.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/appliances/list_appliances.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli vm appliance list">qualys-cli vm appliance list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
978
|
+
<section class="module" id="pc"><header class="module-head"><div class="mod-badge">PC</div><div class="mod-title"><h2>Policy Compliance</h2><p class="mod-sub">Compliance scans, schedules, policies, posture, option profiles</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">8 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-pc-scan">scan<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-pc-scan-schedule">scan-schedule<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-pc-policy">policy<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-pc-posture">posture<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-pc-option-profile">option-profile<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-pc-scan"><h3 class="grp-title"><span class="grp-name">scan</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-pc-scan-list" data-search="pc scan list list compliance scans." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pc scan <span class="verb">list</span></code><p class="cmd-summary">List compliance scans.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/pc_scans/list_pc_scans.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc scan list">qualys-cli pc scan list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--state</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--launched-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pc-scan-launch" data-search="pc scan launch launch a compliance scan." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">launch</span></div><code class="cmd-full">qualys-cli pc scan <span class="verb">launch</span></code><p class="cmd-summary">Launch a compliance scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/pc_scans/launch_pc_scan.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc scan launch --title VALUE --ip VALUE">qualys-cli pc scan launch <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--ip</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-cond">+ 2 required (one-of)</span> · <span class="cnt-opt">4 optional</span></summary><div class="opt-note"><strong>One-of required:</strong> <code class="chip">--option-id</code> <code class="chip">--option-title</code> <span class="opt-note-sub">— pass at least one</span></div><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ip</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--option-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Option profile ID (required if --option-title not given)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--option-title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Option profile title (required if --option-id not given)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--scanner</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Scanner appliance name(s)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--asset-groups</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Asset group IDs, comma-separated (alternative to --ip)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--priority</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">0–9</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pc-scan-schedule"><h3 class="grp-title"><span class="grp-name">scan-schedule</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-pc-scan-schedule-list" data-search="pc scan-schedule list list compliance scan schedules." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">scan-schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pc scan-schedule <span class="verb">list</span></code><p class="cmd-summary">List compliance scan schedules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/pc_schedules/list_compliance_scan_schedules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc scan-schedule list">qualys-cli pc scan-schedule list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pc-scan-schedule-delete" data-search="pc scan-schedule delete delete a compliance scan schedule." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">scan-schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli pc scan-schedule <span class="verb">delete</span></code><p class="cmd-summary">Delete a compliance scan schedule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/pc_schedules/Delete_a_compliance_scan_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc scan-schedule delete <id->">qualys-cli pc scan-schedule delete <span class="arg"><id-></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ID_</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pc-policy"><h3 class="grp-title"><span class="grp-name">policy</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-pc-policy-list" data-search="pc policy list list compliance policies." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">policy</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pc policy <span class="verb">list</span></code><p class="cmd-summary">List compliance policies.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/pc/policies/list_policies.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc policy list">qualys-cli pc policy list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated policy ID(s)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pc-policy-export" data-search="pc policy export export a policy to xml." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">policy</span> <span class='crumb-sep'>›</span> <span class="crumb">export</span></div><code class="cmd-full">qualys-cli pc policy <span class="verb">export</span></code><p class="cmd-summary">Export a policy to XML.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/pc/policies/policy_export.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc policy export">qualys-cli pc policy export</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-cond">+ 1 required (one-of)</span> · <span class="cnt-opt">5 optional</span></summary><div class="opt-note"><strong>One-of required:</strong> <code class="chip">--title</code> <span class="opt-note-sub">— pass at least one</span></div><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ID_</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Policy ID (omit if using --title)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Look up policy by title instead of ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-user-controls</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include user-defined controls</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--show-appendix</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Include the policy appendix</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">policy.xml</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pc-posture"><h3 class="grp-title"><span class="grp-name">posture</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-pc-posture-list" data-search="pc posture list list compliance posture info." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">posture</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pc posture <span class="verb">list</span></code><p class="cmd-summary">List compliance posture info.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/pc/posture/list_posture_info.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc posture list --policy-id VALUE">qualys-cli pc posture list <span class="flag">--policy-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--policy-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Policy ID to evaluate posture against (required by the API).</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--host-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--control-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--status</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Pass|Fail|Error</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Pass</code> <code class="chip">Fail</code> <code class="chip">Error</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pc-option-profile"><h3 class="grp-title"><span class="grp-name">option-profile</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-pc-option-profile-list" data-search="pc option-profile list list pc option profiles." data-mod="pc"><header class="cmd-head"><div class="crumbs"><span class="crumb">pc</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pc option-profile <span class="verb">list</span></code><p class="cmd-summary">List PC option profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/ops/ops_pc/PC_Option_Profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pc option-profile list">qualys-cli pc option-profile list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
979
|
+
<section class="module" id="was"><header class="module-head"><div class="mod-badge">WAS</div><div class="mod-title"><h2>Web Application Scanning</h2><p class="mod-sub">Web apps, scans, findings, auth records, schedules, reports, catalog, DNS overrides, imports</p></div><div class="mod-meta"><span class="auth basic">Basic auth · QPS XML</span><span class="mod-count">60 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-was-webapp">webapp<span class="chip-count">7</span></a><a class="grp-chip" href="#grp-was-scan">scan<span class="chip-count">9</span></a><a class="grp-chip" href="#grp-was-finding">finding<span class="chip-count">9</span></a><a class="grp-chip" href="#grp-was-auth-record">auth-record<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-was-option-profile">option-profile<span class="chip-count">5</span></a><a class="grp-chip" href="#grp-was-schedule">schedule<span class="chip-count">7</span></a><a class="grp-chip" href="#grp-was-report">report<span class="chip-count">8</span></a><a class="grp-chip" href="#grp-was-catalog">catalog<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-was-dns">dns<span class="chip-count">5</span></a><a class="grp-chip" href="#grp-was-import">import<span class="chip-count">2</span></a></div><div class="module-body"><div class="grp" id="grp-was-webapp"><h3 class="grp-title"><span class="grp-name">webapp</span><span class="grp-count">7</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-webapp-list" data-search="was webapp list search/list web applications." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">list</span></code><p class="cmd-summary">Search/list web applications.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/get_webapp_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp list">qualys-cli was webapp list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--url</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by URL (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by tag ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-get" data-search="was webapp get get details of a web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">get</span></code><p class="cmd-summary">Get details of a web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/get_webapp_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp get <webapp-id>">qualys-cli was webapp get <span class="arg"><webapp-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">WEBAPP_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-count" data-search="was webapp count get the count of web applications." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">count</span></code><p class="cmd-summary">Get the count of web applications.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/webapp_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp count">qualys-cli was webapp count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-create" data-search="was webapp create create a web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">create</span></code><p class="cmd-summary">Create a web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/create_webapp.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp create --name VALUE --url VALUE">qualys-cli was webapp create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--url</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Web application name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--url</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Starting URL (e.g. https://myapp.com)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-update" data-search="was webapp update update a web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">update</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">update</span></code><p class="cmd-summary">Update a web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/update_webapp.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp update <webapp-id>">qualys-cli was webapp update <span class="arg"><webapp-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">WEBAPP_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">New name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--url</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">New URL</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-delete" data-search="was webapp delete delete a web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">delete</span></code><p class="cmd-summary">Delete a web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/delete_webapp.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp delete <webapp-id>">qualys-cli was webapp delete <span class="arg"><webapp-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">WEBAPP_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-webapp-purge" data-search="was webapp purge purge all scan data for a web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">webapp</span> <span class='crumb-sep'>›</span> <span class="crumb">purge</span></div><code class="cmd-full">qualys-cli was webapp <span class="verb">purge</span></code><p class="cmd-summary">Purge all scan data for a web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/web_apps/purge_webapp.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was webapp purge <webapp-id>">qualys-cli was webapp purge <span class="arg"><webapp-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">WEBAPP_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-scan"><h3 class="grp-title"><span class="grp-name">scan</span><span class="grp-count">9</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-scan-list" data-search="was scan list search/list was scans." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">list</span></code><p class="cmd-summary">Search/list WAS scans.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/get_scan_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan list">qualys-cli was scan list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by scan name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--status</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">SUBMITTED|RUNNING|FINISHED|ERROR|CANCELLED</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">SUBMITTED</code> <code class="chip">RUNNING</code> <code class="chip">FINISHED</code> <code class="chip">ERROR</code> <code class="chip">CANCELLED</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">VULNERABILITY|DISCOVERY</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">VULNERABILITY</code> <code class="chip">DISCOVERY</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-get" data-search="was scan get get scan details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">get</span></code><p class="cmd-summary">Get scan details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/get_scan_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan get <scan-id>">qualys-cli was scan get <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-count" data-search="was scan count get count of was scans." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">count</span></code><p class="cmd-summary">Get count of WAS scans.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/scan_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan count">qualys-cli was scan count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-status" data-search="was scan status get current status of a scan." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">status</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">status</span></code><p class="cmd-summary">Get current status of a scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/scan_status.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan status <scan-id>">qualys-cli was scan status <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-launch" data-search="was scan launch launch a was scan on a single web application." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">launch</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">launch</span></code><p class="cmd-summary">Launch a WAS scan on a single web application.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/launch_scan_single.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan launch --name VALUE --webapp-id VALUE --profile-id VALUE">qualys-cli was scan launch <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--webapp-id</span> <span class="arg">VALUE</span> <span class="flag">--profile-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Scan name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Web application ID to scan</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--profile-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Option profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">VULNERABILITY|DISCOVERY</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">VULNERABILITY</code> <code class="chip">DISCOVERY</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">VULNERABILITY</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--scanner-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">EXTERNAL|INTERNAL</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">EXTERNAL</code> <code class="chip">INTERNAL</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">EXTERNAL</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-cancel" data-search="was scan cancel cancel an in-progress scan." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">cancel</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">cancel</span></code><p class="cmd-summary">Cancel an in-progress scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/cancel_scan.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan cancel <scan-id>">qualys-cli was scan cancel <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--keep-results</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Retain partial results</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-results" data-search="was scan results download raw xml results for a completed scan." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">results</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">results</span></code><p class="cmd-summary">Download raw XML results for a completed scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/scan_results.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan results <scan-id>">qualys-cli was scan results <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">scan-results.xml</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-delete" data-search="was scan delete delete a scan." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">delete</span></code><p class="cmd-summary">Delete a scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scans/delete_scan.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan delete <scan-id>">qualys-cli was scan delete <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-scan-scan-again" data-search="was scan scan-again re-run a completed scan with the same settings." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">scan-again</span></div><code class="cmd-full">qualys-cli was scan <span class="verb">scan-again</span></code><p class="cmd-summary">Re-run a completed scan with the same settings.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/scan_again.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was scan scan-again <scan-id>">qualys-cli was scan scan-again <span class="arg"><scan-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan ID to re-run</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-finding"><h3 class="grp-title"><span class="grp-name">finding</span><span class="grp-count">9</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-finding-list" data-search="was finding list search/list findings." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">list</span></code><p class="cmd-summary">Search/list findings.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/get_finding_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding list">qualys-cli was finding list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--qid</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Qualys finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--status</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">NEW|ACTIVE|REOPENED|PROTECTED|FIXED</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">NEW</code> <code class="chip">ACTIVE</code> <code class="chip">REOPENED</code> <code class="chip">PROTECTED</code> <code class="chip">FIXED</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">VULNERABILITY|SENSITIVE_CONTENT|INFORMATION_GATHERED</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">VULNERABILITY</code> <code class="chip">SENSITIVE_CONTENT</code> <code class="chip">INFORMATION_GATHERED</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--severity</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">1-5</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-get" data-search="was finding get get details of a finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">get</span></code><p class="cmd-summary">Get details of a finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/get_finding_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding get <finding-id>">qualys-cli was finding get <span class="arg"><finding-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-count" data-search="was finding count get count of findings." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">count</span></code><p class="cmd-summary">Get count of findings.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/finding_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding count">qualys-cli was finding count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-ignore" data-search="was finding ignore ignore a finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">ignore</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">ignore</span></code><p class="cmd-summary">Ignore a finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/ignore_finding.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding ignore <finding-id> --reason FALSE_POSITIVE">qualys-cli was finding ignore <span class="arg"><finding-id></span> <span class="flag">--reason</span> <span class="arg">FALSE_POSITIVE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--reason</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Ignore reason (e.g. FALSE_POSITIVE, NOT_APPLICABLE)</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">FALSE_POSITIVE</code> <code class="chip">NOT_APPLICABLE</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--comment</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-reactivate" data-search="was finding reactivate reactivate (un-ignore) a finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">reactivate</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">reactivate</span></code><p class="cmd-summary">Reactivate (un-ignore) a finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/activate_finding.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding reactivate <finding-id>">qualys-cli was finding reactivate <span class="arg"><finding-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-restore" data-search="was finding restore restore a fixed finding to active state." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">restore</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">restore</span></code><p class="cmd-summary">Restore a fixed finding to active state.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/restore_finding.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding restore <finding-id>">qualys-cli was finding restore <span class="arg"><finding-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-retest" data-search="was finding retest request a retest of a specific finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">retest</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">retest</span></code><p class="cmd-summary">Request a retest of a specific finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/retest_finding.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding retest <finding-id>">qualys-cli was finding retest <span class="arg"><finding-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-retest-status" data-search="was finding retest-status get the retest status of a finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">retest-status</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">retest-status</span></code><p class="cmd-summary">Get the retest status of a finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/retrieve_finding_retest_status.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding retest-status <finding-id>">qualys-cli was finding retest-status <span class="arg"><finding-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-finding-edit-severity" data-search="was finding edit-severity edit the severity of a finding." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">finding</span> <span class='crumb-sep'>›</span> <span class="crumb">edit-severity</span></div><code class="cmd-full">qualys-cli was finding <span class="verb">edit-severity</span></code><p class="cmd-summary">Edit the severity of a finding.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/finding/edit_finding.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was finding edit-severity <finding-id> --severity VALUE">qualys-cli was finding edit-severity <span class="arg"><finding-id></span> <span class="flag">--severity</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">FINDING_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Finding ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--severity</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">New severity 1-5</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--comment</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-auth-record"><h3 class="grp-title"><span class="grp-name">auth-record</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-auth-record-list" data-search="was auth-record list search/list authentication records." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">auth-record</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was auth-record <span class="verb">list</span></code><p class="cmd-summary">Search/list authentication records.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/auth/get_auth_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was auth-record list">qualys-cli was auth-record list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-auth-record-get" data-search="was auth-record get get authentication record details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">auth-record</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was auth-record <span class="verb">get</span></code><p class="cmd-summary">Get authentication record details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/auth/get_auth_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was auth-record get <auth-id>">qualys-cli was auth-record get <span class="arg"><auth-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">AUTH_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Authentication record ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-auth-record-count" data-search="was auth-record count get count of authentication records." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">auth-record</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was auth-record <span class="verb">count</span></code><p class="cmd-summary">Get count of authentication records.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/auth/auth_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was auth-record count">qualys-cli was auth-record count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-auth-record-delete" data-search="was auth-record delete delete an authentication record." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">auth-record</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was auth-record <span class="verb">delete</span></code><p class="cmd-summary">Delete an authentication record.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/auth/delete_auth.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was auth-record delete <auth-id>">qualys-cli was auth-record delete <span class="arg"><auth-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">AUTH_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Authentication record ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-option-profile"><h3 class="grp-title"><span class="grp-name">option-profile</span><span class="grp-count">5</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-option-profile-list" data-search="was option-profile list search/list option profiles." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was option-profile <span class="verb">list</span></code><p class="cmd-summary">Search/list option profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/option_profile/get_op_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was option-profile list">qualys-cli was option-profile list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-option-profile-get" data-search="was option-profile get get option profile details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was option-profile <span class="verb">get</span></code><p class="cmd-summary">Get option profile details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/option_profile/get_op_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was option-profile get <profile-id>">qualys-cli was option-profile get <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Option profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-option-profile-count" data-search="was option-profile count get count of option profiles." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was option-profile <span class="verb">count</span></code><p class="cmd-summary">Get count of option profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/option_profile/op_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was option-profile count">qualys-cli was option-profile count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-option-profile-create" data-search="was option-profile create create an option profile with default settings." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli was option-profile <span class="verb">create</span></code><p class="cmd-summary">Create an option profile with default settings.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/option_profile/create_op.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was option-profile create --name VALUE">qualys-cli was option-profile create <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Option profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-option-profile-delete" data-search="was option-profile delete delete an option profile." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">option-profile</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was option-profile <span class="verb">delete</span></code><p class="cmd-summary">Delete an option profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/option_profile/delete_op.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was option-profile delete <profile-id>">qualys-cli was option-profile delete <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Option profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-schedule"><h3 class="grp-title"><span class="grp-name">schedule</span><span class="grp-count">7</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-schedule-list" data-search="was schedule list search/list scan schedules." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">list</span></code><p class="cmd-summary">Search/list scan schedules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/get_schedule_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule list">qualys-cli was schedule list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--active/--inactive</code></div><div class="opt-meta-bar"><span class="b-type">BOOLEAN</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-get" data-search="was schedule get get schedule details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">get</span></code><p class="cmd-summary">Get schedule details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/get_schedule_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule get <schedule-id>">qualys-cli was schedule get <span class="arg"><schedule-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCHEDULE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-count" data-search="was schedule count get count of scan schedules." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">count</span></code><p class="cmd-summary">Get count of scan schedules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/schedule_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule count">qualys-cli was schedule count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-create" data-search="was schedule create create a scan schedule." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">create</span></code><p class="cmd-summary">Create a scan schedule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/create_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule create --name VALUE --webapp-id VALUE --profile-id VALUE">qualys-cli was schedule create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--webapp-id</span> <span class="arg">VALUE</span> <span class="flag">--profile-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Schedule name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--profile-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Option profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">VULNERABILITY|DISCOVERY</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">VULNERABILITY</code> <code class="chip">DISCOVERY</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">VULNERABILITY</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-activate" data-search="was schedule activate activate a scan schedule." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">activate</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">activate</span></code><p class="cmd-summary">Activate a scan schedule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/activate_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule activate <schedule-id>">qualys-cli was schedule activate <span class="arg"><schedule-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCHEDULE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-deactivate" data-search="was schedule deactivate deactivate a scan schedule." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">deactivate</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">deactivate</span></code><p class="cmd-summary">Deactivate a scan schedule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/deactivate_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule deactivate <schedule-id>">qualys-cli was schedule deactivate <span class="arg"><schedule-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCHEDULE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-schedule-delete" data-search="was schedule delete delete a scan schedule." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">schedule</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was schedule <span class="verb">delete</span></code><p class="cmd-summary">Delete a scan schedule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/schedules/delete_schedule.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was schedule delete <schedule-id>">qualys-cli was schedule delete <span class="arg"><schedule-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCHEDULE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Schedule ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">8</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-report-list" data-search="was report list search/list reports." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was report <span class="verb">list</span></code><p class="cmd-summary">Search/list reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/get_report_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report list">qualys-cli was report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by name (CONTAINS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--status</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">RUNNING|COMPLETE|ERROR</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">RUNNING</code> <code class="chip">COMPLETE</code> <code class="chip">ERROR</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-get" data-search="was report get get report details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was report <span class="verb">get</span></code><p class="cmd-summary">Get report details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/get_report_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report get <report-id>">qualys-cli was report get <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-status" data-search="was report status get the status of a report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">status</span></div><code class="cmd-full">qualys-cli was report <span class="verb">status</span></code><p class="cmd-summary">Get the status of a report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/get_report_status.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report status <report-id>">qualys-cli was report status <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-count" data-search="was report count get count of reports." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was report <span class="verb">count</span></code><p class="cmd-summary">Get count of reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/report_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report count">qualys-cli was report count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-create-webapp" data-search="was report create-webapp create a web application vulnerability report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create-webapp</span></div><code class="cmd-full">qualys-cli was report <span class="verb">create-webapp</span></code><p class="cmd-summary">Create a web application vulnerability report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/report_creation/webapp_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report create-webapp --name VALUE --webapp-id VALUE">qualys-cli was report create-webapp <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--webapp-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Report name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--template-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Report template ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">PDF|HTML|XML|CSV|WORD</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">PDF</code> <code class="chip">HTML</code> <code class="chip">XML</code> <code class="chip">CSV</code> <code class="chip">WORD</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">PDF</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-create-scan" data-search="was report create-scan create a scan-based report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create-scan</span></div><code class="cmd-full">qualys-cli was report <span class="verb">create-scan</span></code><p class="cmd-summary">Create a scan-based report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/report_creation/scan_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report create-scan --name VALUE --scan-id VALUE">qualys-cli was report create-scan <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--scan-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Report name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--scan-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Scan ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--template-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">PDF|HTML|XML|CSV</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">PDF</code> <code class="chip">HTML</code> <code class="chip">XML</code> <code class="chip">CSV</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">PDF</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-download" data-search="was report download download a completed report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli was report <span class="verb">download</span></code><p class="cmd-summary">Download a completed report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/download_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report download <report-id>">qualys-cli was report download <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">was-report.pdf</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-report-delete" data-search="was report delete delete a report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was report <span class="verb">delete</span></code><p class="cmd-summary">Delete a report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/reports/delete_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was report delete <report-id>">qualys-cli was report delete <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-catalog"><h3 class="grp-title"><span class="grp-name">catalog</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-catalog-list" data-search="was catalog list list catalog entries." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">catalog</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was catalog <span class="verb">list</span></code><p class="cmd-summary">List catalog entries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/catalog/get_catalog_entry_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was catalog list">qualys-cli was catalog list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-catalog-count" data-search="was catalog count get count of catalog entries." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">catalog</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was catalog <span class="verb">count</span></code><p class="cmd-summary">Get count of catalog entries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/catalog/count_catalog_entires.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was catalog count">qualys-cli was catalog count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-catalog-add-to-subscription" data-search="was catalog add-to-subscription add a catalog entry to the subscription (creates a web application)." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">catalog</span> <span class='crumb-sep'>›</span> <span class="crumb">add-to-subscription</span></div><code class="cmd-full">qualys-cli was catalog <span class="verb">add-to-subscription</span></code><p class="cmd-summary">Add a catalog entry to the subscription (creates a web application).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/catalog/add_to_subscription.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was catalog add-to-subscription <catalog-id>">qualys-cli was catalog add-to-subscription <span class="arg"><catalog-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CATALOG_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Catalog entry ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-catalog-delete" data-search="was catalog delete delete catalog entries." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">catalog</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was catalog <span class="verb">delete</span></code><p class="cmd-summary">Delete catalog entries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/catalog/delete_catalog_entries.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was catalog delete <catalog-id>">qualys-cli was catalog delete <span class="arg"><catalog-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CATALOG_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Catalog entry ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-dns"><h3 class="grp-title"><span class="grp-name">dns</span><span class="grp-count">5</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-dns-list" data-search="was dns list list dns overrides." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">dns</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli was dns <span class="verb">list</span></code><p class="cmd-summary">List DNS overrides.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/dns_override/get_dns_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was dns list">qualys-cli was dns list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-dns-get" data-search="was dns get get dns override details." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">dns</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli was dns <span class="verb">get</span></code><p class="cmd-summary">Get DNS override details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/dns_override/get_dns_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was dns get <dns-id>">qualys-cli was dns get <span class="arg"><dns-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">DNS_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">DNS override ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-dns-count" data-search="was dns count get count of dns overrides." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">dns</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli was dns <span class="verb">count</span></code><p class="cmd-summary">Get count of DNS overrides.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/dns_override/dns_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was dns count">qualys-cli was dns count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-dns-create" data-search="was dns create create a dns override." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">dns</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli was dns <span class="verb">create</span></code><p class="cmd-summary">Create a DNS override.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/dns_override/create_dns.html" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was dns create --name VALUE --hostname VALUE --ip VALUE">qualys-cli was dns create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--hostname</span> <span class="arg">VALUE</span> <span class="flag">--ip</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">DNS override name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--hostname</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Hostname to override</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ip</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">IP address to map to</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-dns-delete" data-search="was dns delete delete a dns override." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">dns</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli was dns <span class="verb">delete</span></code><p class="cmd-summary">Delete a DNS override.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/dns_override/delete_dns.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was dns delete <dns-id>">qualys-cli was dns delete <span class="arg"><dns-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">DNS_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">DNS override ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-was-import"><h3 class="grp-title"><span class="grp-name">import</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-was-import-burp" data-search="was import burp import findings from a burp suite xml export." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">import</span> <span class='crumb-sep'>›</span> <span class="crumb">burp</span></div><code class="cmd-full">qualys-cli was import <span class="verb">burp</span></code><p class="cmd-summary">Import findings from a Burp Suite XML export.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/burp/import_burp.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was import burp --webapp-id VALUE --file VALUE">qualys-cli was import burp <span class="flag">--webapp-id</span> <span class="arg">VALUE</span> <span class="flag">--file</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Target web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--file</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Path to Burp Suite XML export file</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--purge-results</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Remove previous results</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-was-import-owasp-zap" data-search="was import owasp-zap import findings from an owasp zap xml report." data-mod="was"><header class="cmd-head"><div class="crumbs"><span class="crumb">was</span> <span class='crumb-sep'>›</span> <span class="crumb">import</span> <span class='crumb-sep'>›</span> <span class="crumb">owasp-zap</span></div><code class="cmd-full">qualys-cli was import <span class="verb">owasp-zap</span></code><p class="cmd-summary">Import findings from an OWASP ZAP XML report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/was/api/zap/import_owasp_findings.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli was import owasp-zap --webapp-id VALUE --file VALUE">qualys-cli was import owasp-zap <span class="flag">--webapp-id</span> <span class="arg">VALUE</span> <span class="flag">--file</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--webapp-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Target web application ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--file</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Path to OWASP ZAP XML report file</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--purge-results</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--close-unreported</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Mark unfound issues as fixed</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
980
|
+
<section class="module" id="tc"><header class="module-head"><div class="mod-badge">TC</div><div class="mod-title"><h2>TotalCloud (CSPM)</h2><p class="mod-sub">Cloud connectors, evaluations, alert rules, exceptions, IaC scans, CDR findings</p></div><div class="mod-meta"><span class="auth jwt">JWT Bearer · JSON</span><span class="mod-count">15 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-tc-connector">connector<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-tc-evaluation">evaluation<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-tc-report">report<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-tc-rule">rule<span class="chip-count">5</span></a><a class="grp-chip" href="#grp-tc-exception">exception<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-tc-iac">iac<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-tc-cdr">cdr<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-tc-connector"><h3 class="grp-title"><span class="grp-name">connector</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-connector-list" data-search="tc connector list list cloud connectors for a given provider." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">connector</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc connector <span class="verb">list</span></code><p class="cmd-summary">List cloud connectors for a given provider.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/aws/get_conn.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc connector list --provider VALUE">qualys-cli tc connector list <span class="flag">--provider</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--provider</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Cloud provider: AWS | AZURE | GCP</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter (name, state, connector.uuid)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-evaluation"><h3 class="grp-title"><span class="grp-name">evaluation</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-evaluation-list" data-search="tc evaluation list list evaluation statistics per control for a cloud account." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">evaluation</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc evaluation <span class="verb">list</span></code><p class="cmd-summary">List evaluation statistics per control for a cloud account.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/aws/get_eval_aws.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc evaluation list --provider VALUE --account-id VALUE">qualys-cli tc evaluation list <span class="flag">--provider</span> <span class="arg">VALUE</span> <span class="flag">--account-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--provider</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Cloud provider: AWS | AZURE | GCP</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--account-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Cloud account ID to evaluate (required path segment in the API).</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-report-list" data-search="tc report list list assessment reports." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc report <span class="verb">list</span></code><p class="cmd-summary">List assessment reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/assessment_reports/list_assessment_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc report list">qualys-cli tc report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--created-by</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by creator username</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--status</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Accepted|Completed|Failed|Generated|Processing</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Accepted</code> <code class="chip">Completed</code> <code class="chip">Failed</code> <code class="chip">Generated</code> <code class="chip">Processing</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-report-create" data-search="tc report create create an assessment report." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli tc report <span class="verb">create</span></code><p class="cmd-summary">Create an assessment report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/reports/create_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc report create --name VALUE --cloud-type AWS --start-date VALUE --end-date VALUE --report-format VALUE --policy-ids VALUE --connector-ids VALUE">qualys-cli tc report create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--start-date</span> <span class="arg">VALUE</span> <span class="flag">--end-date</span> <span class="arg">VALUE</span> <span class="flag">--report-format</span> <span class="arg">VALUE</span> <span class="flag">--policy-ids</span> <span class="arg">VALUE</span> <span class="flag">--connector-ids</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">7 required</span> · <span class="cnt-opt">10 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Report name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--start-date</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">e.g. 2025-09-03T15:43:38Z</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--end-date</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--report-format</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Output format: csv|pdf|ON_SCREEN (required)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--policy-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Comma-separated policy IDs (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--connector-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Comma-separated connector IDs (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--execution-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">RUN_TIME|BUILD_TIME|SCHEDULED</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">RUN_TIME</code> <code class="chip">BUILD_TIME</code> <code class="chip">SCHEDULED</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">RUN_TIME</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated tag IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--group-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated connector-group IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--query</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter for resources</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--include-resource-arn</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">AWS only: include resource ARNs in PDF</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--resource-results</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated subset of: PASS, PassE, FAIL</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">PASS</code> <code class="chip">PassE</code> <code class="chip">FAIL</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--iac-resource-results</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated IaC resource result filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-report-download" data-search="tc report download download an assessment report as a zip." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli tc report <span class="verb">download</span></code><p class="cmd-summary">Download an assessment report as a ZIP.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/assessment_reports/download_assessment_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc report download <report-id>">qualys-cli tc report download <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">tc-report.zip</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-rule"><h3 class="grp-title"><span class="grp-name">rule</span><span class="grp-count">5</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-rule-list" data-search="tc rule list list alert rules." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">rule</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc rule <span class="verb">list</span></code><p class="cmd-summary">List alert rules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/rules/get_rules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc rule list --cloud-type AWS --rule-type VALUE">qualys-cli tc rule list <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--rule-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--rule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">simple_alert|time_window_schedule_alert (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter (ruleName, ruleState, etc.)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-rule-create" data-search="tc rule create create an alert rule." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">rule</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli tc rule <span class="verb">create</span></code><p class="cmd-summary">Create an alert rule.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/rules/create_rules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc rule create --cloud-type AWS --rule-type VALUE --name VALUE --qql VALUE --action-id VALUE --action-type VALUE">qualys-cli tc rule create <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--rule-type</span> <span class="arg">VALUE</span> <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--qql</span> <span class="arg">VALUE</span> <span class="flag">--action-id</span> <span class="arg">VALUE</span> <span class="flag">--action-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">6 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--rule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">simple_alert|time_window_schedule_alert</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--qql</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Rule QQL query</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--action-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--action-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">qemail|pagerduty|slack</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-rule-enable" data-search="tc rule enable enable one or more rules." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">rule</span> <span class='crumb-sep'>›</span> <span class="crumb">enable</span></div><code class="cmd-full">qualys-cli tc rule <span class="verb">enable</span></code><p class="cmd-summary">Enable one or more rules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/rules/enable_rules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc rule enable <rule-ids> --cloud-type AWS --rule-type VALUE">qualys-cli tc rule enable <span class="arg"><rule-ids></span> <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--rule-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">RULE_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated rule IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--rule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">simple_alert|time_window_schedule_alert (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-rule-disable" data-search="tc rule disable disable one or more rules." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">rule</span> <span class='crumb-sep'>›</span> <span class="crumb">disable</span></div><code class="cmd-full">qualys-cli tc rule <span class="verb">disable</span></code><p class="cmd-summary">Disable one or more rules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/rules/disable_rules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc rule disable <rule-ids> --cloud-type AWS --rule-type VALUE">qualys-cli tc rule disable <span class="arg"><rule-ids></span> <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--rule-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">RULE_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated rule IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--rule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">simple_alert|time_window_schedule_alert (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-rule-delete" data-search="tc rule delete delete one or more rules." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">rule</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli tc rule <span class="verb">delete</span></code><p class="cmd-summary">Delete one or more rules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/rules/delete_rules.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc rule delete <rule-ids> --cloud-type AWS --rule-type VALUE">qualys-cli tc rule delete <span class="arg"><rule-ids></span> <span class="flag">--cloud-type</span> <span class="arg">AWS</span> <span class="flag">--rule-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">RULE_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated rule IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">AWS|Azure|GCP|OCI</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">Azure</code> <code class="chip">GCP</code> <code class="chip">OCI</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--rule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">simple_alert|time_window_schedule_alert (required by API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-exception"><h3 class="grp-title"><span class="grp-name">exception</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-exception-list" data-search="tc exception list list exceptions." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">exception</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc exception <span class="verb">list</span></code><p class="cmd-summary">List exceptions.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/exception_management/list_exceptions.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc exception list">qualys-cli tc exception list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter (exception.provider, exception.status, etc.)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-exception-delete" data-search="tc exception delete delete exceptions." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">exception</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli tc exception <span class="verb">delete</span></code><p class="cmd-summary">Delete exceptions.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/exception_management/delete_exceptions.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc exception delete <exception-ids>">qualys-cli tc exception delete <span class="arg"><exception-ids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">EXCEPTION_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated exception IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-iac"><h3 class="grp-title"><span class="grp-name">iac</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-iac-list" data-search="tc iac list list iac scans." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">iac</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli tc iac <span class="verb">list</span></code><p class="cmd-summary">List IaC scans.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/iac/get_iac_scan_list.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc iac list">qualys-cli tc iac list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter (status, scanUuid, scanDate)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-no</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-tc-iac-get" data-search="tc iac get get iac scan result by uuid." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">iac</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli tc iac <span class="verb">get</span></code><p class="cmd-summary">Get IaC scan result by UUID.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/iac/get_iac_scan_result.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc iac get <scan-uuid>">qualys-cli tc iac get <span class="arg"><scan-uuid></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SCAN_UUID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Scan UUID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-tc-cdr"><h3 class="grp-title"><span class="grp-name">cdr</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-tc-cdr-findings" data-search="tc cdr findings get cdr security threat findings." data-mod="tc"><header class="cmd-head"><div class="crumbs"><span class="crumb">tc</span> <span class='crumb-sep'>›</span> <span class="crumb">cdr</span> <span class='crumb-sep'>›</span> <span class="crumb">findings</span></div><code class="cmd-full">qualys-cli tc cdr <span class="verb">findings</span></code><p class="cmd-summary">Get CDR security threat findings.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/tc/api/cdr/get_cdr_findings.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli tc cdr findings --query VALUE --start-at VALUE --end-at VALUE">qualys-cli tc cdr findings <span class="flag">--query</span> <span class="arg">VALUE</span> <span class="flag">--start-at</span> <span class="arg">VALUE</span> <span class="flag">--end-at</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--query</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">QQL query (e.g. tc.findings.cloudProvider:AWS)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--start-at</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Start timestamp e.g. 2025-01-01T00:00:00Z</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--end-at</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">End timestamp</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-provider</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">AWS|AZURE|GCP</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AWS</code> <code class="chip">AZURE</code> <code class="chip">GCP</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cloud-account</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit-val</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Max records to return</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--offset</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
981
|
+
<section class="module" id="ca"><header class="module-head"><div class="mod-badge">CA</div><div class="mod-title"><h2>Cloud Agent</h2><p class="mod-sub">Agent lifecycle, on-demand scans, activation keys, configuration profiles</p></div><div class="mod-meta"><span class="auth mixed">Basic + JWT · XML/JSON</span><span class="mod-count">15 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-ca-agent">agent<span class="chip-count">7</span></a><a class="grp-chip" href="#grp-ca-scan">scan<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-ca-act-key">act-key<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-ca-config">config<span class="chip-count">3</span></a></div><div class="module-body"><div class="grp" id="grp-ca-agent"><h3 class="grp-title"><span class="grp-name">agent</span><span class="grp-count">7</span></h3><div class="grp-body"><article class="cmd" id="cmd-ca-agent-list" data-search="ca agent list list cloud agents (post search)." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">list</span></code><p class="cmd-summary">List cloud agents (POST search).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/list_agents.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent list">qualys-cli ca agent list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--tag</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag NAME filter (default: "Cloud Agent" — override if your account uses a different tag)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag ID filter (more reliable than name)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tracking-method</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by tracking method (e.g. AGENT) — alternative to --tag</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--fields</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated fields to include in the response</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-count" data-search="ca agent count get count of cloud agents in the account." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">count</span></code><p class="cmd-summary">Get count of cloud agents in the account.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/agent_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent count">qualys-cli ca agent count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--tag</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag NAME filter (default: "Cloud Agent" — override if your account uses a different tag)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag ID filter (more reliable than name)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tracking-method</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by tracking method (e.g. AGENT) — alternative to --tag</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-activate" data-search="ca agent activate activate a cloud agent for one or more modules." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">activate</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">activate</span></code><p class="cmd-summary">Activate a cloud agent for one or more modules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/activate_agent.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent activate <asset-id> --module AGENT_VM">qualys-cli ca agent activate <span class="arg"><asset-id></span> <span class="flag">--module</span> <span class="arg">AGENT_VM</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID of the agent</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--module</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Module(s): AGENT_VM,AGENT_PC,AGENT_FIM,AGENT_EDR,AGENT_SCA</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AGENT_VM</code> <code class="chip">AGENT_PC</code> <code class="chip">AGENT_FIM</code> <code class="chip">AGENT_EDR</code> <code class="chip">AGENT_SCA</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-deactivate" data-search="ca agent deactivate deactivate a cloud agent for one or more modules." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">deactivate</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">deactivate</span></code><p class="cmd-summary">Deactivate a cloud agent for one or more modules.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/deactivate_agent.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent deactivate <asset-id> --module AGENT_VM">qualys-cli ca agent deactivate <span class="arg"><asset-id></span> <span class="flag">--module</span> <span class="arg">AGENT_VM</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID of the agent</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--module</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Module(s): AGENT_VM,AGENT_PC,AGENT_FIM,AGENT_EDR,AGENT_SCA</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">AGENT_VM</code> <code class="chip">AGENT_PC</code> <code class="chip">AGENT_FIM</code> <code class="chip">AGENT_EDR</code> <code class="chip">AGENT_SCA</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-uninstall" data-search="ca agent uninstall uninstall a cloud agent." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">uninstall</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">uninstall</span></code><p class="cmd-summary">Uninstall a cloud agent.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/uninstall_agent.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent uninstall <asset-id>">qualys-cli ca agent uninstall <span class="arg"><asset-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID of the agent</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-bulk-activate" data-search="ca agent bulk-activate bulk activate agents matching a tag." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">bulk-activate</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">bulk-activate</span></code><p class="cmd-summary">Bulk activate agents matching a tag.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/bulk_activation.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent bulk-activate --module VALUE">qualys-cli ca agent bulk-activate <span class="flag">--module</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--module</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Module(s) to activate</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag name filter</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">Cloud Agent</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-agent-bulk-deactivate" data-search="ca agent bulk-deactivate bulk deactivate agents matching a tag." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">agent</span> <span class='crumb-sep'>›</span> <span class="crumb">bulk-deactivate</span></div><code class="cmd-full">qualys-cli ca agent <span class="verb">bulk-deactivate</span></code><p class="cmd-summary">Bulk deactivate agents matching a tag.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/agents/bulk_deactivation.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca agent bulk-deactivate --module VALUE">qualys-cli ca agent bulk-deactivate <span class="flag">--module</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--module</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Module(s) to deactivate</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag name filter</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">Cloud Agent</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-ca-scan"><h3 class="grp-title"><span class="grp-name">scan</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-ca-scan-launch-ods" data-search="ca scan launch-ods launch an on-demand scan for agents matching a tag." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">scan</span> <span class='crumb-sep'>›</span> <span class="crumb">launch-ods</span></div><code class="cmd-full">qualys-cli ca scan <span class="verb">launch-ods</span></code><p class="cmd-summary">Launch an on-demand scan for agents matching a tag.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/scans/ods_for_multiple_asset.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca scan launch-ods --scan-type Inventory_Scan">qualys-cli ca scan launch-ods <span class="flag">--scan-type</span> <span class="arg">Inventory_Scan</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--scan-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Inventory_Scan|Vulnerability_Scan|PolicyCompliance_Scan|UDC_Scan|SCA_Scan|SWCA_scan</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Inventory_Scan</code> <code class="chip">Vulnerability_Scan</code> <code class="chip">PolicyCompliance_Scan</code> <code class="chip">UDC_Scan</code> <code class="chip">SCA_Scan</code> <code class="chip">SWCA_scan</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Tag name filter for target assets</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">Cloud Agent</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--override-cpu</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Override CPU throttle limits</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-ca-act-key"><h3 class="grp-title"><span class="grp-name">act-key</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-ca-act-key-list" data-search="ca act-key list search/list activation keys." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">act-key</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli ca act-key <span class="verb">list</span></code><p class="cmd-summary">Search/list activation keys.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/act_key/act_key_apis.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca act-key list">qualys-cli ca act-key list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-act-key-get" data-search="ca act-key get get activation key details." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">act-key</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli ca act-key <span class="verb">get</span></code><p class="cmd-summary">Get activation key details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/act_key/get_act_key_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca act-key get <key-id>">qualys-cli ca act-key get <span class="arg"><key-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">KEY_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Activation key ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-act-key-create" data-search="ca act-key create create a new activation key." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">act-key</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli ca act-key <span class="verb">create</span></code><p class="cmd-summary">Create a new activation key.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/act_key/create_act_key.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca act-key create --title VALUE">qualys-cli ca act-key create <span class="flag">--title</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Activation key title</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--licenses</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated license types (e.g. VM,PC,FIM,EDR,SCA)</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">VM</code> <code class="chip">PC</code> <code class="chip">FIM</code> <code class="chip">EDR</code> <code class="chip">SCA</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--network-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--expire-date</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">ISO datetime e.g. 2026-12-31T23:59:59Z</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--max-agents</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Maximum agents allowed for this key</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tags</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated tag IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-act-key-delete" data-search="ca act-key delete delete an activation key." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">act-key</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli ca act-key <span class="verb">delete</span></code><p class="cmd-summary">Delete an activation key.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/act_key/delete_act_key.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca act-key delete <key-id>">qualys-cli ca act-key delete <span class="arg"><key-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">KEY_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Activation key ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-ca-config"><h3 class="grp-title"><span class="grp-name">config</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-ca-config-list" data-search="ca config list list configuration profiles." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">config</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli ca config <span class="verb">list</span></code><p class="cmd-summary">List configuration profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/config/config_apis.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca config list">qualys-cli ca config list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-config-create" data-search="ca config create create a configuration profile." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">config</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli ca config <span class="verb">create</span></code><p class="cmd-summary">Create a configuration profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/config/config_api/create_config_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca config create --name VALUE">qualys-cli ca config create <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-ca-config-delete" data-search="ca config delete delete a configuration profile." data-mod="ca"><header class="cmd-head"><div class="crumbs"><span class="crumb">ca</span> <span class='crumb-sep'>›</span> <span class="crumb">config</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli ca config <span class="verb">delete</span></code><p class="cmd-summary">Delete a configuration profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/ca/api/config/config_api/delete_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli ca config delete <profile-id>">qualys-cli ca config delete <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
982
|
+
<section class="module" id="cs"><header class="module-head"><div class="mod-badge">CS</div><div class="mod-title"><h2>Container Security</h2><p class="mod-sub">Images, containers, registries, sensors, vulnerability reports</p></div><div class="mod-meta"><span class="auth jwt">JWT Bearer · JSON</span><span class="mod-count">18 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-cs-image">image<span class="chip-count">5</span></a><a class="grp-chip" href="#grp-cs-container">container<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-cs-registry">registry<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-cs-sensor">sensor<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-cs-report">report<span class="chip-count">4</span></a></div><div class="module-body"><div class="grp" id="grp-cs-image"><h3 class="grp-title"><span class="grp-name">image</span><span class="grp-count">5</span></h3><div class="grp-body"><article class="cmd" id="cmd-cs-image-list" data-search="cs image list list images in the account (max 10,000)." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">image</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli cs image <span class="verb">list</span></code><p class="cmd-summary">List images in the account (max 10,000).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_a_list_of_images_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs image list">qualys-cli cs image list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Qualys QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--server-sort</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Server-side sort, e.g. created:desc. Use --sort/--sort-by for client-side post-processing.</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-image-get" data-search="cs image get get details of a specific image." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">image</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli cs image <span class="verb">get</span></code><p class="cmd-summary">Get details of a specific image.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_image_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs image get <image-sha>">qualys-cli cs image get <span class="arg"><image-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IMAGE_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Image SHA value</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--scan-details</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">malware,secrets,compliance</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-image-vulns" data-search="cs image vulns get vulnerability details for an image." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">image</span> <span class='crumb-sep'>›</span> <span class="crumb">vulns</span></div><code class="cmd-full">qualys-cli cs image <span class="verb">vulns</span></code><p class="cmd-summary">Get vulnerability details for an image.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_vulnerability_details_for_an_image.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs image vulns <image-sha>">qualys-cli cs image vulns <span class="arg"><image-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IMAGE_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Image SHA value</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-image-software" data-search="cs image software list software installed on an image." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">image</span> <span class='crumb-sep'>›</span> <span class="crumb">software</span></div><code class="cmd-full">qualys-cli cs image <span class="verb">software</span></code><p class="cmd-summary">List software installed on an image.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/fetch_a_list_of_software_installed_on_an_image.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs image software <image-sha>">qualys-cli cs image software <span class="arg"><image-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IMAGE_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Image SHA value</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-image-delete" data-search="cs image delete delete images matching a filter." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">image</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli cs image <span class="verb">delete</span></code><p class="cmd-summary">Delete images matching a filter.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/images/delete_images_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs image delete --filter VALUE">qualys-cli cs image delete <span class="flag">--filter</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">QQL filter to select images to delete</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-cs-container"><h3 class="grp-title"><span class="grp-name">container</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-cs-container-list" data-search="cs container list list containers in the account." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">container</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli cs container <span class="verb">list</span></code><p class="cmd-summary">List containers in the account.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_a_list_of_containers_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs container list">qualys-cli cs container list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Qualys QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--server-sort</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Server-side sort (passed to API). Use --sort/--sort-by for client-side.</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-container-get" data-search="cs container get get details of a specific container." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">container</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli cs container <span class="verb">get</span></code><p class="cmd-summary">Get details of a specific container.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_container_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs container get <container-sha>">qualys-cli cs container get <span class="arg"><container-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CONTAINER_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Container SHA</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-container-vulns" data-search="cs container vulns get vulnerability details for a container." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">container</span> <span class='crumb-sep'>›</span> <span class="crumb">vulns</span></div><code class="cmd-full">qualys-cli cs container <span class="verb">vulns</span></code><p class="cmd-summary">Get vulnerability details for a container.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_vulnerability_details_for_a_container.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs container vulns <container-sha>">qualys-cli cs container vulns <span class="arg"><container-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CONTAINER_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Container SHA</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-container-software" data-search="cs container software list software installed on a container." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">container</span> <span class='crumb-sep'>›</span> <span class="crumb">software</span></div><code class="cmd-full">qualys-cli cs container <span class="verb">software</span></code><p class="cmd-summary">List software installed on a container.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/containers/fetch_a_list_of_software_installed_on_a_container.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs container software <container-sha>">qualys-cli cs container software <span class="arg"><container-sha></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CONTAINER_SHA</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Container SHA</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-cs-registry"><h3 class="grp-title"><span class="grp-name">registry</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-cs-registry-list" data-search="cs registry list list registries." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">registry</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli cs registry <span class="verb">list</span></code><p class="cmd-summary">List registries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/fetch_a_list_of_registries_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs registry list">qualys-cli cs registry list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-registry-get" data-search="cs registry get get registry details." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">registry</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli cs registry <span class="verb">get</span></code><p class="cmd-summary">Get registry details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/fetch_registry_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs registry get <registry-uuid>">qualys-cli cs registry get <span class="arg"><registry-uuid></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REGISTRY_UUID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Registry UUID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-registry-delete" data-search="cs registry delete delete one or more registries." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">registry</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli cs registry <span class="verb">delete</span></code><p class="cmd-summary">Delete one or more registries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/registries/delete_registries_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs registry delete <registry-uuids>">qualys-cli cs registry delete <span class="arg"><registry-uuids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REGISTRY_UUIDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated registry UUIDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-cs-sensor"><h3 class="grp-title"><span class="grp-name">sensor</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-cs-sensor-list" data-search="cs sensor list list sensors." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">sensor</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli cs sensor <span class="verb">list</span></code><p class="cmd-summary">List sensors.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/sensors/fetch_a_list_of_sensors_in_your_account.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs sensor list">qualys-cli cs sensor list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--server-sort</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Server-side sort (passed to API). Use --sort/--sort-by for client-side.</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-sensor-get" data-search="cs sensor get get sensor details." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">sensor</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli cs sensor <span class="verb">get</span></code><p class="cmd-summary">Get sensor details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/sensors/fetch_sensor_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs sensor get <sensor-uuid>">qualys-cli cs sensor get <span class="arg"><sensor-uuid></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SENSOR_UUID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Sensor UUID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-cs-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-cs-report-list" data-search="cs report list list vulnerability reports." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli cs report <span class="verb">list</span></code><p class="cmd-summary">List vulnerability reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/fetch_a_list_of_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs report list">qualys-cli cs report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-report-create" data-search="cs report create create a new vulnerability report request." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli cs report <span class="verb">create</span></code><p class="cmd-summary">Create a new vulnerability report request.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/create_a_report_request.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs report create --name VALUE --template CS_IMAGE_VULNERABILITY --expire-after VALUE">qualys-cli cs report create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--template</span> <span class="arg">CS_IMAGE_VULNERABILITY</span> <span class="flag">--expire-after</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">3 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Report title (max 150 chars)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--template</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">CS_IMAGE_VULNERABILITY|CS_CONTAINER_VULNERABILITY|CS_IMAGE_SECRETS|CS_IMAGE_MALWARE</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">CS_IMAGE_VULNERABILITY</code> <code class="chip">CS_CONTAINER_VULNERABILITY</code> <code class="chip">CS_IMAGE_SECRETS</code> <code class="chip">CS_IMAGE_MALWARE</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--expire-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Days until expiry: 1|7|30|90</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-report-download" data-search="cs report download download a report in json format." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli cs report <span class="verb">download</span></code><p class="cmd-summary">Download a report in JSON format.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/fetch_a_report_in_json_format.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs report download <report-uuid>">qualys-cli cs report download <span class="arg"><report-uuid></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_UUID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report UUID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">cs-report.json</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-cs-report-delete" data-search="cs report delete delete one or more reports." data-mod="cs"><header class="cmd-head"><div class="crumbs"><span class="crumb">cs</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli cs report <span class="verb">delete</span></code><p class="cmd-summary">Delete one or more reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/cs/latest/mergedProjects/container_security_apis/vulnerability_reports/delete_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cs report delete <report-uuids>">qualys-cli cs report delete <span class="arg"><report-uuids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_UUIDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated report UUIDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
983
|
+
<section class="module" id="csam"><header class="module-head"><div class="mod-badge">CSAM</div><div class="mod-title"><h2>CyberSecurity Asset Management</h2><p class="mod-sub">Assets, EASM, vulnerabilities, domains, reports, software components, business metadata, third-party connectors, organizations</p></div><div class="mod-meta"><span class="auth jwt">JWT Bearer · JSON</span><span class="mod-count">27 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-csam-asset">asset<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-csam-easm">easm<span class="chip-count">9</span></a><a class="grp-chip" href="#grp-csam-vuln">vuln<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-csam-domain">domain<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-csam-report">report<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-csam-component">component<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-csam-business">business<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-csam-connector">connector<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-csam-org">org<span class="chip-count">2</span></a></div><div class="module-body"><div class="grp" id="grp-csam-asset"><h3 class="grp-title"><span class="grp-name">asset</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-asset-count" data-search="csam asset count get the count of assets matching filter criteria." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli csam asset <span class="verb">count</span></code><p class="cmd-summary">Get the count of assets matching filter criteria.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/asset_host_data/count_of_assets.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam asset count">qualys-cli csam asset count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span></div><div class="opt-body"><div class="opt-help">Repeatable filter as field=op=value (e.g. asset.riskScore=GREATER=500)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--updated-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">yyyy-MM-ddTHH:mmZ</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-asset-list" data-search="csam asset list get host details for all assets (max 100 per call, use --last-seen-id to paginate)." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli csam asset <span class="verb">list</span></code><p class="cmd-summary">Get host details for all assets (max 100 per call, use --last-seen-id to paginate).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/asset_host_data/get_host_details_of_all_assets.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam asset list">qualys-cli csam asset list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span></div><div class="opt-body"><div class="opt-help">Repeatable filter as field=op=value (e.g. asset.riskScore=GREATER=500)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--updated-after</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">yyyy-MM-ddTHH:mmZ</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-seen-id</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Paginate from this asset ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--include-fields</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated fields to include</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--exclude-fields</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated fields to exclude</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-asset-get" data-search="csam asset get get host details for a specific asset." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli csam asset <span class="verb">get</span></code><p class="cmd-summary">Get host details for a specific asset.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/asset_host_data/get_host_details_of_specific_asset.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam asset get <asset-id>">qualys-cli csam asset get <span class="arg"><asset-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--include-fields</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--exclude-fields</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-asset-sn-export" data-search="csam asset sn-export export an asset in servicenow-style format including software-instance details." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">sn-export</span></div><code class="cmd-full">qualys-cli csam asset <span class="verb">sn-export</span></code><p class="cmd-summary">Export an asset in ServiceNow-style format including software-instance details.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/release-notes/cybersecurity_asset_management/release_3_7_api.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam asset sn-export <asset-id>">qualys-cli csam asset sn-export <span class="arg"><asset-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">json</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-easm"><h3 class="grp-title"><span class="grp-name">easm</span><span class="grp-count">9</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-easm-list" data-search="csam easm list list easm profiles." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">list</span></code><p class="cmd-summary">List EASM profiles.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/get_easm_profile_data.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm list">qualys-cli csam easm list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-create" data-search="csam easm create create an easm profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">create</span></code><p class="cmd-summary">Create an EASM profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/create_easm_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm create --name VALUE">qualys-cli csam easm create <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--default</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Set as default profile</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--domain-security</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-update" data-search="csam easm update update an easm profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">update</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">update</span></code><p class="cmd-summary">Update an EASM profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/update_easm_profile_data.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm update <profile-id>">qualys-cli csam easm update <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">EASM profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--active/--inactive</code></div><div class="opt-meta-bar"><span class="b-type">BOOLEAN</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-delete" data-search="csam easm delete delete an easm profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">delete</span></code><p class="cmd-summary">Delete an EASM profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/delete_easm_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm delete <profile-id>">qualys-cli csam easm delete <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">EASM profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-activate" data-search="csam easm activate activate an easm profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">activate</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">activate</span></code><p class="cmd-summary">Activate an EASM profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/activate_deactive_easm_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm activate <profile-id>">qualys-cli csam easm activate <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">EASM profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-deactivate" data-search="csam easm deactivate deactivate an easm profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">deactivate</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">deactivate</span></code><p class="cmd-summary">Deactivate an EASM profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/activate_deactive_easm_profile.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm deactivate <profile-id>">qualys-cli csam easm deactivate <span class="arg"><profile-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">EASM profile ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-orgs" data-search="csam easm orgs list easm organizations/subsidiaries." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">orgs</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">orgs</span></code><p class="cmd-summary">List EASM organizations/subsidiaries.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/org_list_api.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm orgs">qualys-cli csam easm orgs</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-status" data-search="csam easm status get easm discovery status for a profile." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">status</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">status</span></code><p class="cmd-summary">Get EASM discovery status for a profile.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/get_easm_profile_discovery_status.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm status --name VALUE">qualys-cli csam easm status <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">EASM profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-easm-patch" data-search="csam easm patch partially update an easm profile via patch (additive — does not affect `easm update`)." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">easm</span> <span class='crumb-sep'>›</span> <span class="crumb">patch</span></div><code class="cmd-full">qualys-cli csam easm <span class="verb">patch</span></code><p class="cmd-summary">Partially update an EASM profile via PATCH (additive — does not affect `easm update`).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/patch_easm_profile_data.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam easm patch <profile-name> --body VALUE">qualys-cli csam easm patch <span class="arg"><profile-name></span> <span class="flag">--body</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PROFILE_NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">EASM profile name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--body</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Raw JSON body for the PATCH request</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-vuln"><h3 class="grp-title"><span class="grp-name">vuln</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-vuln-list-easm" data-search="csam vuln list-easm list easm-discovered vulnerabilities." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">vuln</span> <span class='crumb-sep'>›</span> <span class="crumb">list-easm</span></div><code class="cmd-full">qualys-cli csam vuln <span class="verb">list-easm</span></code><p class="cmd-summary">List EASM-discovered vulnerabilities.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/vulnerabilities/get_list_easm_discovered_vuln.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam vuln list-easm">qualys-cli csam vuln list-easm</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span></div><div class="opt-body"><div class="opt-help">Repeatable filter as field=op=value (e.g. vulnerabilities.severity=EQUALS=2)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-seen-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Pagination cursor — pass the lastSeenId from the previous response</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-vuln-list-scan" data-search="csam vuln list-scan list vulnerabilities discovered by easm scan." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">vuln</span> <span class='crumb-sep'>›</span> <span class="crumb">list-scan</span></div><code class="cmd-full">qualys-cli csam vuln <span class="verb">list-scan</span></code><p class="cmd-summary">List vulnerabilities discovered by EASM scan.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/vulnerabilities/vulns_discovered_easm_scan.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam vuln list-scan">qualys-cli csam vuln list-scan</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span></div><div class="opt-body"><div class="opt-help">Repeatable filter as field=op=value (e.g. vulnerabilities.severity=EQUALS=2)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-seen-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Pagination cursor — pass the lastSeenId from the previous response</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-vuln-data" data-search="csam vuln data fetch vulnerability data for software/os cpes across assets." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">vuln</span> <span class='crumb-sep'>›</span> <span class="crumb">data</span></div><code class="cmd-full">qualys-cli csam vuln <span class="verb">data</span></code><p class="cmd-summary">Fetch vulnerability data for software/OS CPEs across assets.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/vulnerabilities/vuln_data_sw_os_across_assets.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam vuln data --cpe-ids VALUE">qualys-cli csam vuln data <span class="flag">--cpe-ids</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--cpe-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Comma-separated CPE IDs (max 100)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--cpe-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Qualys|NIST</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Qualys</code> <code class="chip">NIST</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-domain"><h3 class="grp-title"><span class="grp-name">domain</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-domain-list" data-search="csam domain list list unresolved and typosquatted domains discovered by easm." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">domain</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli csam domain <span class="verb">list</span></code><p class="cmd-summary">List unresolved and typosquatted domains discovered by EASM.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/domains/get_list_of_unresolved_domains.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam domain list">qualys-cli csam domain list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">UNRESOLVED_DOMAINS</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">ALL|DOMAIN|SUBDOMAIN</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">ALL</code> <code class="chip">DOMAIN</code> <code class="chip">SUBDOMAIN</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">5000</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-id</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Paginate from this domain ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-domain-count" data-search="csam domain count get count of unresolved domains." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">domain</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli csam domain <span class="verb">count</span></code><p class="cmd-summary">Get count of unresolved domains.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/domains/get_count_of_unresolved_domains.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam domain count">qualys-cli csam domain count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">UNRESOLVED_DOMAINS</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">ALL|DOMAIN|SUBDOMAIN</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">ALL</code> <code class="chip">DOMAIN</code> <code class="chip">SUBDOMAIN</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-report-create" data-search="csam report create create an easm summary report." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli csam report <span class="verb">create</span></code><p class="cmd-summary">Create an EASM summary report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/reports/create_reports_api.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam report create --name VALUE --format-type VALUE --template VALUE --report-type VALUE">qualys-cli csam report create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--format-type</span> <span class="arg">VALUE</span> <span class="flag">--template</span> <span class="arg">VALUE</span> <span class="flag">--report-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">4 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Report name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Output format e.g. PDF</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--template</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">e.g. EASM_LEAD</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--report-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">e.g. EASM_LEAD</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--query</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-report-download" data-search="csam report download download a completed report by name." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli csam report <span class="verb">download</span></code><p class="cmd-summary">Download a completed report by name.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/reports/download_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam report download --name VALUE">qualys-cli csam report download <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Exact report name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">csam-report.pdf</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-component"><h3 class="grp-title"><span class="grp-name">component</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-component-list" data-search="csam component list list software components (swca) discovered across assets." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">component</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli csam component <span class="verb">list</span></code><p class="cmd-summary">List software components (SwCA) discovered across assets.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/software_component/get_list_of_all_software_components.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam component list">qualys-cli csam component list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">8 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">JSON filter body</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-seen-id</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Paginate from this component ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-component-list-by-asset" data-search="csam component list-by-asset list software components (swca) for a single asset." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">component</span> <span class='crumb-sep'>›</span> <span class="crumb">list-by-asset</span></div><code class="cmd-full">qualys-cli csam component <span class="verb">list-by-asset</span></code><p class="cmd-summary">List software components (SwCA) for a single asset.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/software_component/get_list_of_software_components_for_specific_asset.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam component list-by-asset <asset-id>">qualys-cli csam component list-by-asset <span class="arg"><asset-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">ASSET_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Asset ID to fetch components for</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">JSON filter body</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-business"><h3 class="grp-title"><span class="grp-name">business</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-business-import-asset" data-search="csam business import-asset import business metadata (criticality, owner, environment, etc.) for assets." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">business</span> <span class='crumb-sep'>›</span> <span class="crumb">import-asset</span></div><code class="cmd-full">qualys-cli csam business <span class="verb">import-asset</span></code><p class="cmd-summary">Import business metadata (criticality, owner, environment, etc.) for assets.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/business_information/import_asset_business_metadata.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam business import-asset <input-file>">qualys-cli csam business import-asset <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">CSV/JSON file with asset business metadata</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Skip confirmation</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-business-import-app" data-search="csam business import-app upsert business application metadata (apps and asset linkages)." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">business</span> <span class='crumb-sep'>›</span> <span class="crumb">import-app</span></div><code class="cmd-full">qualys-cli csam business <span class="verb">import-app</span></code><p class="cmd-summary">Upsert business application metadata (apps and asset linkages).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/business_information/import_business_app_metadata.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam business import-app <input-file>">qualys-cli csam business import-app <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">CSV/JSON file with business application metadata</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Skip confirmation</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-connector"><h3 class="grp-title"><span class="grp-name">connector</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-connector-sync" data-search="csam connector sync push third-party assets/findings into csam via the webhook connector." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">connector</span> <span class='crumb-sep'>›</span> <span class="crumb">sync</span></div><code class="cmd-full">qualys-cli csam connector <span class="verb">sync</span></code><p class="cmd-summary">Push third-party assets/findings into CSAM via the webhook connector.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/third_party/import_third_party_assets.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam connector sync <input-file>">qualys-cli csam connector sync <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">JSON payload describing third-party assets/findings</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-csam-org"><h3 class="grp-title"><span class="grp-name">org</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-csam-org-list" data-search="csam org list search organizations and subsidiaries (post search)." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">org</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli csam org <span class="verb">list</span></code><p class="cmd-summary">Search organizations and subsidiaries (POST search).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/org_list_api.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam org list">qualys-cli csam org list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">JSON filter body</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-number</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-csam-org-count" data-search="csam org count count organizations and subsidiaries matching a filter." data-mod="csam"><header class="cmd-head"><div class="crumbs"><span class="crumb">csam</span> <span class='crumb-sep'>›</span> <span class="crumb">org</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli csam org <span class="verb">count</span></code><p class="cmd-summary">Count organizations and subsidiaries matching a filter.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/csam/api/easm_apis/org_count_api.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli csam org count">qualys-cli csam org count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--filter</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">JSON filter body</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
984
|
+
<section class="module" id="pm"><header class="module-head"><div class="mod-badge">PM</div><div class="mod-title"><h2>Patch Management</h2><p class="mod-sub">Deployment jobs, mitigations, patches, reports, managed assets</p></div><div class="mod-meta"><span class="auth jwt">JWT Bearer · JSON</span><span class="mod-count">19 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-pm-job">job<span class="chip-count">8</span></a><a class="grp-chip" href="#grp-pm-mitigation">mitigation<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-pm-patch">patch<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-pm-report">report<span class="chip-count">4</span></a><a class="grp-chip" href="#grp-pm-asset">asset<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-pm-job"><h3 class="grp-title"><span class="grp-name">job</span><span class="grp-count">8</span></h3><div class="grp-body"><article class="cmd" id="cmd-pm-job-list" data-search="pm job list list deployment jobs." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">list</span></code><p class="cmd-summary">List deployment jobs.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_list.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job list">qualys-cli pm job list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--all</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Fetch all pages</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">table|json|yaml</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-get" data-search="pm job get get a deployment job by id." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">get</span></code><p class="cmd-summary">Get a deployment job by ID.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_by_id.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job get <job-id>">qualys-cli pm job get <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-create" data-search="pm job create create a deployment job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">create</span></code><p class="cmd-summary">Create a deployment job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/create_deployment_job.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job create --name VALUE --schedule-type On-demand">qualys-cli pm job create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--schedule-type</span> <span class="arg">On-demand</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">5 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Job name</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--schedule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">On-demand|Once|Daily|Weekly|Monthly</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">On-demand</code> <code class="chip">Once</code> <code class="chip">Daily</code> <code class="chip">Weekly</code> <code class="chip">Monthly</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--platform</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Windows|Linux</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Windows</code> <code class="chip">Linux</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">Windows</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--start</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Start datetime YYYY-MM-DD HH:MM:SS</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tag-ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated tag UUIDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-update" data-search="pm job update update a deployment job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">update</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">update</span></code><p class="cmd-summary">Update a deployment job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/update_deployment_jobs.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job update <job-id>">qualys-cli pm job update <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--schedule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-delete" data-search="pm job delete delete a deployment job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">delete</span></code><p class="cmd-summary">Delete a deployment job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/delete_deployment_jobs.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job delete <job-id>">qualys-cli pm job delete <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Skip confirmation</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-change-status" data-search="pm job change-status enable or disable one or more deployment jobs." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">change-status</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">change-status</span></code><p class="cmd-summary">Enable or disable one or more deployment jobs.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/change_the_status_of_deployment_jobs.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job change-status <job-ids> <action>">qualys-cli pm job change-status <span class="arg"><job-ids></span> <span class="arg"><action></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated deployment job IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">ACTION</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Enabled|Disabled</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Enabled</code> <code class="chip">Disabled</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-runs" data-search="pm job runs list runs for a deployment job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">runs</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">runs</span></code><p class="cmd-summary">List runs for a deployment job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/get_list_of_runs_for_particular_deployment_job.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job runs <job-id>">qualys-cli pm job runs <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-job-summary" data-search="pm job summary get result summary for a deployment job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">job</span> <span class='crumb-sep'>›</span> <span class="crumb">summary</span></div><code class="cmd-full">qualys-cli pm job <span class="verb">summary</span></code><p class="cmd-summary">Get result summary for a deployment job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_result_summary.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm job summary <job-id>">qualys-cli pm job summary <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pm-mitigation"><h3 class="grp-title"><span class="grp-name">mitigation</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-pm-mitigation-list" data-search="pm mitigation list list mitigation deployment jobs." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">mitigation</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pm mitigation <span class="verb">list</span></code><p class="cmd-summary">List mitigation deployment jobs.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/mitigation_apis/get_list_of_all_mitigation_jobs.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm mitigation list">qualys-cli pm mitigation list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-mitigation-create" data-search="pm mitigation create create a mitigation job." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">mitigation</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli pm mitigation <span class="verb">create</span></code><p class="cmd-summary">Create a mitigation job.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/mitigation_apis/create_mitigation_job.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm mitigation create --name VALUE --schedule-type VALUE">qualys-cli pm mitigation create <span class="flag">--name</span> <span class="arg">VALUE</span> <span class="flag">--schedule-type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--schedule-type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-mitigation-delete" data-search="pm mitigation delete delete mitigation jobs." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">mitigation</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli pm mitigation <span class="verb">delete</span></code><p class="cmd-summary">Delete mitigation jobs.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/mitigation_apis/delete_mitigation_jobs.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm mitigation delete <job-id>">qualys-cli pm mitigation delete <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pm-patch"><h3 class="grp-title"><span class="grp-name">patch</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-pm-patch-list" data-search="pm patch list list patches from the patch catalog." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">patch</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pm patch <span class="verb">list</span></code><p class="cmd-summary">List patches from the patch catalog.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_catalog_resource/get_patch_catalog_patches.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm patch list">qualys-cli pm patch list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">7 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--platform</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Windows|Linux</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Windows</code> <code class="chip">Linux</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--severity</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Critical|Important|Moderate|Low</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Critical</code> <code class="chip">Important</code> <code class="chip">Moderate</code> <code class="chip">Low</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--all</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-patch-count" data-search="pm patch count get patch count." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">patch</span> <span class='crumb-sep'>›</span> <span class="crumb">count</span></div><code class="cmd-full">qualys-cli pm patch <span class="verb">count</span></code><p class="cmd-summary">Get patch count.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/scan_result_patch_resource/get_patch_count.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm patch count">qualys-cli pm patch count</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--platform</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-patch-products" data-search="pm patch products list products affected by a specific patch." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">patch</span> <span class='crumb-sep'>›</span> <span class="crumb">products</span></div><code class="cmd-full">qualys-cli pm patch <span class="verb">products</span></code><p class="cmd-summary">List products affected by a specific patch.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_catalog_resource/get_patch_catalog_products.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm patch products <patch-id>">qualys-cli pm patch products <span class="arg"><patch-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PATCH_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Patch ID to list products for</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pm-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">4</span></h3><div class="grp-body"><article class="cmd" id="cmd-pm-report-list" data-search="pm report list list generated pm reports." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pm report <span class="verb">list</span></code><p class="cmd-summary">List generated PM reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_report_resource/get_list_of_generated_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm report list">qualys-cli pm report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-report-generate" data-search="pm report generate generate a deployment job progress report." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">generate</span></div><code class="cmd-full">qualys-cli pm report <span class="verb">generate</span></code><p class="cmd-summary">Generate a deployment job progress report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_report_resource/generate_patch_insights_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm report generate <job-id>">qualys-cli pm report generate <span class="arg"><job-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">JOB_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Deployment job ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--report-format</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">CSV|PDF</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">CSV</code> <code class="chip">PDF</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">CSV</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-report-download" data-search="pm report download download a generated report to a local file." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli pm report <span class="verb">download</span></code><p class="cmd-summary">Download a generated report to a local file.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_report_resource/get_report_in_csv_format.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm report download <report-id>">qualys-cli pm report download <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Save path</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">report.csv</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-pm-report-columns" data-search="pm report columns fetch available report columns." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">columns</span></div><code class="cmd-full">qualys-cli pm report <span class="verb">columns</span></code><p class="cmd-summary">Fetch available report columns.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/patch_report_resource/get_list_of_report_columns.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm report columns --platform Windows --report-section Asset">qualys-cli pm report columns <span class="flag">--platform</span> <span class="arg">Windows</span> <span class="flag">--report-section</span> <span class="arg">Asset</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--platform</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Windows|Linux</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Windows</code> <code class="chip">Linux</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--report-section</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Asset|Patch|JobProgress</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Asset</code> <code class="chip">Patch</code> <code class="chip">JobProgress</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-pm-asset"><h3 class="grp-title"><span class="grp-name">asset</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-pm-asset-list" data-search="pm asset list list pm-managed assets." data-mod="pm"><header class="cmd-head"><div class="crumbs"><span class="crumb">pm</span> <span class='crumb-sep'>›</span> <span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli pm asset <span class="verb">list</span></code><p class="cmd-summary">List PM-managed assets.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/pm/api/scan_result_asset_resource/get_pm_assets.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli pm asset list">qualys-cli pm asset list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
985
|
+
<section class="module" id="etm"><header class="module-head"><div class="mod-badge">ETM</div><div class="mod-title"><h2>Enterprise TruRisk Management</h2><p class="mod-sub">Finding reports — list, create, get, download, delete</p></div><div class="mod-meta"><span class="auth jwt">JWT Bearer · JSON</span><span class="mod-count">7 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-etm-report">report<span class="chip-count">7</span></a></div><div class="module-body"><div class="grp" id="grp-etm-report"><h3 class="grp-title"><span class="grp-name">report</span><span class="grp-count">7</span></h3><div class="grp-body"><article class="cmd" id="cmd-etm-report-list" data-search="etm report list list active etm reports." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">list</span></code><p class="cmd-summary">List active ETM reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/list_of_active_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report list">qualys-cli etm report list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--offset</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Pagination offset (0-based)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--page-size</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Items per page on the API</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">50</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-create" data-search="etm report create submit a finding report request." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">create</span></code><p class="cmd-summary">Submit a finding report request.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/submit_finding_report.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report create --report-format JSON">qualys-cli etm report create <span class="flag">--report-format</span> <span class="arg">JSON</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--report-format</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">JSON|PARQUET</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">JSON</code> <code class="chip">PARQUET</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--asset-qql</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Asset QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--findings-qql</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Findings QQL filter</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-get" data-search="etm report get get details of a specific etm report." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">get</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">get</span></code><p class="cmd-summary">Get details of a specific ETM report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/get_report_details.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report get <report-id>">qualys-cli etm report get <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-download" data-search="etm report download download all resources for an etm report as a zip." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">download</span></code><p class="cmd-summary">Download all resources for an ETM report as a ZIP.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/download_all_resources_zip.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report download <report-id>">qualys-cli etm report download <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">etm-report.zip</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-download-resource" data-search="etm report download-resource download a specific resource file from an etm report." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">download-resource</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">download-resource</span></code><p class="cmd-summary">Download a specific resource file from an ETM report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/download_report_using_resource_name.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report download-resource <report-id> <resource-name>">qualys-cli etm report download-resource <span class="arg"><report-id></span> <span class="arg"><resource-name></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">RESOURCE_NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Resource name (e.g. part_15097524224131306.json)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-delete" data-search="etm report delete delete an etm report." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">delete</span></code><p class="cmd-summary">Delete an ETM report.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/delete_report_id.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report delete <report-id>">qualys-cli etm report delete <span class="arg"><report-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Report ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-etm-report-bulk-delete" data-search="etm report bulk-delete bulk delete etm reports." data-mod="etm"><header class="cmd-head"><div class="crumbs"><span class="crumb">etm</span> <span class='crumb-sep'>›</span> <span class="crumb">report</span> <span class='crumb-sep'>›</span> <span class="crumb">bulk-delete</span></div><code class="cmd-full">qualys-cli etm report <span class="verb">bulk-delete</span></code><p class="cmd-summary">Bulk delete ETM reports.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/etm/latest/mergedProjects/etm_apis/reports/bulk_delete_reports.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli etm report bulk-delete <report-ids>">qualys-cli etm report bulk-delete <span class="arg"><report-ids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">REPORT_IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated report IDs</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
986
|
+
<section class="module" id="asset"><header class="module-head"><div class="mod-badge">AST</div><div class="mod-title"><h2>Asset Management</h2><p class="mod-sub">IPs, networks, domains, asset groups</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">8 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-asset-ip">ip<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-asset-network">network<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-asset-domain">domain<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-asset-group">group<span class="chip-count">2</span></a></div><div class="module-body"><div class="grp" id="grp-asset-ip"><h3 class="grp-title"><span class="grp-name">ip</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-asset-ip-list" data-search="asset ip list list ips in the subscription." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">ip</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli asset ip <span class="verb">list</span></code><p class="cmd-summary">List IPs in the subscription.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/asset_ips/list_ips.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset ip list">qualys-cli asset ip list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by IP/range</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--network-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-asset-ip-add" data-search="asset ip add add ips to the subscription." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">ip</span> <span class='crumb-sep'>›</span> <span class="crumb">add</span></div><code class="cmd-full">qualys-cli asset ip <span class="verb">add</span></code><p class="cmd-summary">Add IPs to the subscription.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/asset_ips/add_ips.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset ip add <ips>">qualys-cli asset ip add <span class="arg"><ips></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IPS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">IP(s) or range(s) to add</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--tracking</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">IP|DNS|NETBIOS</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">IP</code> <code class="chip">DNS</code> <code class="chip">NETBIOS</code></div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">IP</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-asset-network"><h3 class="grp-title"><span class="grp-name">network</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-asset-network-list" data-search="asset network list list networks." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">network</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli asset network <span class="verb">list</span></code><p class="cmd-summary">List networks.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/networks/list_networks.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset network list">qualys-cli asset network list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-asset-network-create" data-search="asset network create create a network." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">network</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli asset network <span class="verb">create</span></code><p class="cmd-summary">Create a network.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/networks/create_network.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset network create --name VALUE">qualys-cli asset network create <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-asset-domain"><h3 class="grp-title"><span class="grp-name">domain</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-asset-domain-list" data-search="asset domain list list asset domains." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">domain</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli asset domain <span class="verb">list</span></code><p class="cmd-summary">List asset domains.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scans/maps/domains_list.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset domain list">qualys-cli asset domain list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-asset-domain-create" data-search="asset domain create create an asset domain." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">domain</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli asset domain <span class="verb">create</span></code><p class="cmd-summary">Create an asset domain.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/domain_v2/Create_Domain.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset domain create --name VALUE">qualys-cli asset domain create <span class="flag">--name</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-asset-group"><h3 class="grp-title"><span class="grp-name">group</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-asset-group-list" data-search="asset group list list asset groups." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">group</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli asset group <span class="verb">list</span></code><p class="cmd-summary">List asset groups.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/asset_groups/list_asset_groups.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset group list">qualys-cli asset group list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-asset-group-delete" data-search="asset group delete delete asset group(s)." data-mod="asset"><header class="cmd-head"><div class="crumbs"><span class="crumb">asset</span> <span class='crumb-sep'>›</span> <span class="crumb">group</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli asset group <span class="verb">delete</span></code><p class="cmd-summary">Delete asset group(s).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/assets/asset_groups/delete_asset_group.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli asset group delete <ids>">qualys-cli asset group delete <span class="arg"><ids></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">IDS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
987
|
+
<section class="module" id="scanauth"><header class="module-head"><div class="mod-badge">SAU</div><div class="mod-title"><h2>Scan Auth Records</h2><p class="mod-sub">Authentication records and vaults — generic, Neo4j, Nginx</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">7 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-scanauth-record">record<span class="chip-count">1</span></a><a class="grp-chip" href="#grp-scanauth-vault">vault<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-scanauth-neo4j">neo4j<span class="chip-count">2</span></a><a class="grp-chip" href="#grp-scanauth-nginx">nginx<span class="chip-count">2</span></a></div><div class="module-body"><div class="grp" id="grp-scanauth-record"><h3 class="grp-title"><span class="grp-name">record</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-scanauth-record-list" data-search="scanauth record list list authentication records." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">record</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli scanauth record <span class="verb">list</span></code><p class="cmd-summary">List authentication records.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/record_list/list_records.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth record list">qualys-cli scanauth record list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Auth record type — selects the per-type endpoint. One of: unix, windows, oracle, oracle_listener, ms_sql, mysql, db2, snmp, http, postgresql, vmware, ibm_was, tomcat, jboss, mongodb, cisco, checkpoint_firewall, palo_alto_firewall, ad_workspace, azure, aws, gcp, kubernetes, docker, nginx, neo4j, sybase, mariadb, informix, as400</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ids</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by record IDs (comma-separated)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Filter by title substring</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--id-min</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--id-max</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-scanauth-vault"><h3 class="grp-title"><span class="grp-name">vault</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-scanauth-vault-list" data-search="scanauth vault list list authentication vaults." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">vault</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli scanauth vault <span class="verb">list</span></code><p class="cmd-summary">List authentication vaults.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/vaults/list_vaults.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth vault list">qualys-cli scanauth vault list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">9 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Vault type (e.g. CyberArk AIM)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--modified</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Modified on/after YYYY-MM-DD</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--orderby</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">id|title|system_name|last_modified</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--sortorder</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">asc|desc</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-scanauth-vault-create" data-search="scanauth vault create create an authentication vault." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">vault</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli scanauth vault <span class="verb">create</span></code><p class="cmd-summary">Create an authentication vault.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/vaults/create_vault.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth vault create --title VALUE --type VALUE">qualys-cli scanauth vault create <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--type</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-cond">+ 1 required (one-of)</span> · <span class="cnt-opt">11 optional</span></summary><div class="opt-note"><strong>One-of required:</strong> <code class="chip">--field</code> <span class="opt-note-sub">— pass at least one</span></div><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--type</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Vault type (e.g. CyberArk AIM)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--comments</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--appid</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">CyberArk AIM: application ID (required for that type)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--safe</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">CyberArk AIM / PIM: safe name (required for those types)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--url</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Vault server URL (required for most types)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--username</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Vault auth username</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--password</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Vault auth password</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--token</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">API token (Thycotic, HashiCorp, etc.)</div><div class="opt-meta"><span class="opt-meta-key">Allowed</span> <code class="chip">Thycotic</code> <code class="chip">HashiCorp</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--namespace</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">HashiCorp namespace</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--role</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">HashiCorp role</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--secret-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">HashiCorp / Thycotic secret ID</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--field</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span> <span class="b-cond">required (one-of)</span></div><div class="opt-body"><div class="opt-help">Arbitrary type-specific field as key=value (repeatable). Use for any param not exposed as a dedicated flag.</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-scanauth-neo4j"><h3 class="grp-title"><span class="grp-name">neo4j</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-scanauth-neo4j-list" data-search="scanauth neo4j list list neo4j authentication records." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">neo4j</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli scanauth neo4j <span class="verb">list</span></code><p class="cmd-summary">List Neo4j authentication records.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/record_types/neo4j.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth neo4j list">qualys-cli scanauth neo4j list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-scanauth-neo4j-create" data-search="scanauth neo4j create create a neo4j authentication record." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">neo4j</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli scanauth neo4j <span class="verb">create</span></code><p class="cmd-summary">Create a Neo4j authentication record.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/record_types/neo4j.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth neo4j create --title VALUE --username VALUE --password VALUE --ips VALUE --port VALUE">qualys-cli scanauth neo4j create <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--username</span> <span class="arg">VALUE</span> <span class="flag">--password</span> <span class="arg">VALUE</span> <span class="flag">--ips</span> <span class="arg">VALUE</span> <span class="flag">--port</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">5 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--username</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--password</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--port</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--database</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-scanauth-nginx"><h3 class="grp-title"><span class="grp-name">nginx</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-scanauth-nginx-list" data-search="scanauth nginx list list nginx authentication records." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">nginx</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli scanauth nginx <span class="verb">list</span></code><p class="cmd-summary">List Nginx authentication records.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/record_types/nginx_record.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth nginx list">qualys-cli scanauth nginx list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-scanauth-nginx-create" data-search="scanauth nginx create create an nginx authentication record." data-mod="scanauth"><header class="cmd-head"><div class="crumbs"><span class="crumb">scanauth</span> <span class='crumb-sep'>›</span> <span class="crumb">nginx</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli scanauth nginx <span class="verb">create</span></code><p class="cmd-summary">Create an Nginx authentication record.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/scanauth/record_types/nginx_record.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli scanauth nginx create --title VALUE --ips VALUE">qualys-cli scanauth nginx create <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--ips</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--ips</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--unix-base-path</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--unix-conf-path</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--unix-prefix-path</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
988
|
+
<section class="module" id="user"><header class="module-head"><div class="mod-badge">USR</div><div class="mod-title"><h2>User Management</h2><p class="mod-sub">List, create, and reset users in your subscription</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">3 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-user-general">general<span class="chip-count">3</span></a></div><div class="module-body"><div class="grp" id="grp-user-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-user-list" data-search="user list list users in the subscription." data-mod="user"><header class="cmd-head"><div class="crumbs"><span class="crumb">user</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli user <span class="verb">list</span></code><p class="cmd-summary">List users in the subscription.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/users/users/list_users.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli user list">qualys-cli user list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--external-id-contains</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--external-id-assigned</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">1=assigned, 0=unassigned</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--limit</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">25</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-user-create" data-search="user create create a new user account." data-mod="user"><header class="cmd-head"><div class="crumbs"><span class="crumb">user</span> <span class='crumb-sep'>›</span> <span class="crumb">create</span></div><code class="cmd-full">qualys-cli user <span class="verb">create</span></code><p class="cmd-summary">Create a new user account.</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/users/users/params_users.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli user create --role VALUE --business-unit VALUE --first-name VALUE --last-name VALUE --title VALUE --phone VALUE --email VALUE --address VALUE --city VALUE --country VALUE">qualys-cli user create <span class="flag">--role</span> <span class="arg">VALUE</span> <span class="flag">--business-unit</span> <span class="arg">VALUE</span> <span class="flag">--first-name</span> <span class="arg">VALUE</span> <span class="flag">--last-name</span> <span class="arg">VALUE</span> <span class="flag">--title</span> <span class="arg">VALUE</span> <span class="flag">--phone</span> <span class="arg">VALUE</span> <span class="flag">--email</span> <span class="arg">VALUE</span> <span class="flag">--address</span> <span class="arg">VALUE</span> <span class="flag">--city</span> <span class="arg">VALUE</span> <span class="flag">--country</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">10 required</span> · <span class="cnt-opt">6 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--role</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">manager|unit_manager|scanner|reader|contact|administrator</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--business-unit</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">'Unassigned' or existing BU title</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--first-name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--last-name</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--title</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Job title</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--phone</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--email</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--address</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--city</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--country</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Country code</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--state</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--zip</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--asset-groups</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-help">Comma-separated asset groups</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--send-email</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">1=send registration email, 0=return credentials</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--external-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-user-change-password" data-search="user change-password reset passwords for users (auto-generated passwords)." data-mod="user"><header class="cmd-head"><div class="crumbs"><span class="crumb">user</span> <span class='crumb-sep'>›</span> <span class="crumb">change-password</span></div><code class="cmd-full">qualys-cli user <span class="verb">change-password</span></code><p class="cmd-summary">Reset passwords for users (auto-generated passwords).</p><a class="cmd-doc-link" href="https://docs.qualys.com/en/vm/api/users/users_mgmt/change_password.htm" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli user change-password <user-logins>">qualys-cli user change-password <span class="arg"><user-logins></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">USER_LOGINS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Comma-separated login IDs or 'all'</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--send-email</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">1=send email, 0=return passwords in output</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
989
|
+
<section class="module" id="sub"><header class="module-head"><div class="mod-badge">SUB</div><div class="mod-title"><h2>Subscription Management</h2><p class="mod-sub">Subscription info, configuration export/import, user preferences</p></div><div class="mod-meta"><span class="auth basic">Basic auth · XML</span><span class="mod-count">5 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-sub-general">general<span class="chip-count">3</span></a><a class="grp-chip" href="#grp-sub-user-prefs">user-prefs<span class="chip-count">2</span></a></div><div class="module-body"><div class="grp" id="grp-sub-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">3</span></h3><div class="grp-body"><article class="cmd" id="cmd-sub-info" data-search="sub info show subscription details: product entitlements, user counts, scanner info." data-mod="sub"><header class="cmd-head"><div class="crumbs"><span class="crumb">sub</span> <span class='crumb-sep'>›</span> <span class="crumb">info</span></div><code class="cmd-full">qualys-cli sub <span class="verb">info</span></code><p class="cmd-summary">Show subscription details: product entitlements, user counts, scanner info.</p><a class="cmd-doc-link" href="https://www.qualys.com/docs/qualys-subscription-api-user-guide.pdf" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli sub info">qualys-cli sub info</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-sub-export" data-search="sub export export full subscription configuration." data-mod="sub"><header class="cmd-head"><div class="crumbs"><span class="crumb">sub</span> <span class='crumb-sep'>›</span> <span class="crumb">export</span></div><code class="cmd-full">qualys-cli sub <span class="verb">export</span></code><p class="cmd-summary">Export full subscription configuration.</p><a class="cmd-doc-link" href="https://www.qualys.com/docs/qualys-subscription-api-user-guide.pdf" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli sub export">qualys-cli sub export</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-sub-import" data-search="sub import import subscription configuration from a previously exported xml file." data-mod="sub"><header class="cmd-head"><div class="crumbs"><span class="crumb">sub</span> <span class='crumb-sep'>›</span> <span class="crumb">import</span></div><code class="cmd-full">qualys-cli sub <span class="verb">import</span></code><p class="cmd-summary">Import subscription configuration from a previously exported XML file.</p><a class="cmd-doc-link" href="https://www.qualys.com/docs/qualys-subscription-api-user-guide.pdf" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli sub import <input-file>">qualys-cli sub import <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">XML file produced by 'sub export'</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Skip confirmation</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div><div class="grp" id="grp-sub-user-prefs"><h3 class="grp-title"><span class="grp-name">user-prefs</span><span class="grp-count">2</span></h3><div class="grp-body"><article class="cmd" id="cmd-sub-user-prefs-export" data-search="sub user-prefs export export user preferences to an xml file." data-mod="sub"><header class="cmd-head"><div class="crumbs"><span class="crumb">sub</span> <span class='crumb-sep'>›</span> <span class="crumb">user-prefs</span> <span class='crumb-sep'>›</span> <span class="crumb">export</span></div><code class="cmd-full">qualys-cli sub user-prefs <span class="verb">export</span></code><p class="cmd-summary">Export user preferences to an XML file.</p><a class="cmd-doc-link" href="https://www.qualys.com/docs/qualys-subscription-api-user-guide.pdf" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli sub user-prefs export --user-id VALUE">qualys-cli sub user-prefs export <span class="flag">--user-id</span> <span class="arg">VALUE</span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--user-id</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span></div><div class="opt-body"><div class="opt-help">Numeric Qualys user ID (required by the API)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">user-prefs-export.xml</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-sub-user-prefs-import" data-search="sub user-prefs import import user preferences from a previously exported xml file." data-mod="sub"><header class="cmd-head"><div class="crumbs"><span class="crumb">sub</span> <span class='crumb-sep'>›</span> <span class="crumb">user-prefs</span> <span class='crumb-sep'>›</span> <span class="crumb">import</span></div><code class="cmd-full">qualys-cli sub user-prefs <span class="verb">import</span></code><p class="cmd-summary">Import user preferences from a previously exported XML file.</p><a class="cmd-doc-link" href="https://www.qualys.com/docs/qualys-subscription-api-user-guide.pdf" target="_blank" rel="noopener">Qualys API doc ↗</a></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli sub user-prefs import <input-file>">qualys-cli sub user-prefs import <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">XML file produced by 'user-prefs export'</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--yes</code> <code class="opt-alt">-y</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Skip confirmation</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--verbose</code> <code class="opt-alt">-v</code></div><div class="opt-meta-bar"><span class="b-type">FLAG (repeatable)</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
990
|
+
<section class="module" id="doctor"><header class="module-head"><div class="mod-badge">DR</div><div class="mod-title"><h2>Doctor</h2><p class="mod-sub">Preflight: creds, JWT, gateway reachability, audit log writability</p></div><div class="mod-meta"><span class="auth mixed">Local + HEAD</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-doctor-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-doctor-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-doctor" data-search="doctor verify creds, jwt exchange, gateway reachability, and audit log writability." data-mod="doctor"><header class="cmd-head"><div class="crumbs"><span class="crumb">doctor</span></div><code class="cmd-full">qualys-cli <span class="verb">doctor</span></code><p class="cmd-summary">Verify creds, JWT exchange, gateway reachability, and audit log writability.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli doctor">qualys-cli doctor</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--json</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Emit a single JSON object instead of a panel</div></div></li></ul></details></article></div></div></div></section>
|
|
991
|
+
<section class="module" id="health"><header class="module-head"><div class="mod-badge">HC</div><div class="mod-title"><h2>Health probe</h2><p class="mod-sub">Machine-readable liveness check (exit 0 iff API reachable)</p></div><div class="mod-meta"><span class="auth basic">Local + HEAD</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-health-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-health-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-health" data-search="health exit 0 iff creds load and the gateway is reachable. json on stdout." data-mod="health"><header class="cmd-head"><div class="crumbs"><span class="crumb">health</span></div><code class="cmd-full">qualys-cli <span class="verb">health</span></code><p class="cmd-summary">Exit 0 iff creds load and the gateway is reachable. JSON on stdout.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli health">qualys-cli health</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li></ul></details></article></div></div></div></section>
|
|
992
|
+
<section class="module" id="stats"><header class="module-head"><div class="mod-badge">ST</div><div class="mod-title"><h2>Audit-log analytics</h2><p class="mod-sub">Local call counts, latency p50/p90/p99, retry rate, error breakdown</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-stats-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-stats-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-stats" data-search="stats compute call counts, latency percentiles, retry rate, and error breakdown." data-mod="stats"><header class="cmd-head"><div class="crumbs"><span class="crumb">stats</span></div><code class="cmd-full">qualys-cli <span class="verb">stats</span></code><p class="cmd-summary">Compute call counts, latency percentiles, retry rate, and error breakdown.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli stats">qualys-cli stats</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--json</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Emit raw JSON only</div></div></li></ul></details></article></div></div></div></section>
|
|
993
|
+
<section class="module" id="rotate-jwt"><header class="module-head"><div class="mod-badge">RJ</div><div class="mod-title"><h2>Rotate JWT</h2><p class="mod-sub">Force a fresh credential exchange against /auth</p></div><div class="mod-meta"><span class="auth jwt">JWT exchange</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-rotate-jwt-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-rotate-jwt-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-rotate-jwt" data-search="rotate-jwt drop the cached jwt and exchange a new one against ``/auth``." data-mod="rotate-jwt"><header class="cmd-head"><div class="crumbs"><span class="crumb">rotate-jwt</span></div><code class="cmd-full">qualys-cli <span class="verb">rotate-jwt</span></code><p class="cmd-summary">Drop the cached JWT and exchange a new one against ``/auth``.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli rotate-jwt">qualys-cli rotate-jwt</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li></ul></details></article></div></div></div></section>
|
|
994
|
+
<section class="module" id="verify-audit"><header class="module-head"><div class="mod-badge">VA</div><div class="mod-title"><h2>Verify audit chain</h2><p class="mod-sub">Validate the HMAC chain of the local audit log</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-verify-audit-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-verify-audit-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-verify-audit" data-search="verify-audit verify that the local audit log hasn't been tampered with." data-mod="verify-audit"><header class="cmd-head"><div class="crumbs"><span class="crumb">verify-audit</span></div><code class="cmd-full">qualys-cli <span class="verb">verify-audit</span></code><p class="cmd-summary">Verify that the local audit log hasn't been tampered with.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli verify-audit">qualys-cli verify-audit</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">PATH</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Path to audit.log (default: standard location)</div></div></li></ul></details></article></div></div></div></section>
|
|
995
|
+
<section class="module" id="last"><header class="module-head"><div class="mod-badge">LA</div><div class="mod-title"><h2>Show last response</h2><p class="mod-sub">Re-render the most recent successful response for the active profile</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-last-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-last-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-last" data-search="last re-render the most recent successful response captured for *profile*." data-mod="last"><header class="cmd-head"><div class="crumbs"><span class="crumb">last</span></div><code class="cmd-full">qualys-cli <span class="verb">last</span></code><p class="cmd-summary">Re-render the most recent successful response captured for *profile*.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli last">qualys-cli last</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li></ul></details></article></div></div></div></section>
|
|
996
|
+
<section class="module" id="replay"><header class="module-head"><div class="mod-badge">RP</div><div class="mod-title"><h2>Replay by correlation</h2><p class="mod-sub">Re-render a prior response by correlation ID</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-replay-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-replay-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-replay" data-search="replay re-render a specific previous response." data-mod="replay"><header class="cmd-head"><div class="crumbs"><span class="crumb">replay</span></div><code class="cmd-full">qualys-cli <span class="verb">replay</span></code><p class="cmd-summary">Re-render a specific previous response.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli replay <correlation-id>">qualys-cli replay <span class="arg"><correlation-id></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CORRELATION_ID</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Correlation ID from a previous run</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--format</code> <code class="opt-alt">-f</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">table</code></div></div></li></ul></details></article></div></div></div></section>
|
|
997
|
+
<section class="module" id="watch"><header class="module-head"><div class="mod-badge">WT</div><div class="mod-title"><h2>Watch a command</h2><p class="mod-sub">Re-run a list command on an interval (poll + diff)</p></div><div class="mod-meta"><span class="auth basic">Subprocess loop</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-watch-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-watch-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-watch" data-search="watch re-run *cmd* every *interval* seconds, clearing the screen each time." data-mod="watch"><header class="cmd-head"><div class="crumbs"><span class="crumb">watch</span></div><code class="cmd-full">qualys-cli <span class="verb">watch</span></code><p class="cmd-summary">Re-run *cmd* every *interval* seconds, clearing the screen each time.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli watch <cmd>">qualys-cli watch <span class="arg"><cmd></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">CMD</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Command to repeat, e.g. vm scan list --state Running</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--interval</code> <code class="opt-alt">-n</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Seconds between runs</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">15</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--iterations</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Stop after N runs (0 = forever)</div></div></li></ul></details></article></div></div></div></section>
|
|
998
|
+
<section class="module" id="batch"><header class="module-head"><div class="mod-badge">BT</div><div class="mod-title"><h2>Batch runner</h2><p class="mod-sub">Execute a YAML batch of commands, optionally in parallel</p></div><div class="mod-meta"><span class="auth basic">Subprocess fan-out</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-batch-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-batch-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-batch" data-search="batch run a list of commands sequentially or in parallel." data-mod="batch"><header class="cmd-head"><div class="crumbs"><span class="crumb">batch</span></div><code class="cmd-full">qualys-cli <span class="verb">batch</span></code><p class="cmd-summary">Run a list of commands sequentially or in parallel.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli batch <input-file>">qualys-cli batch <span class="arg"><input-file></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">3 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">INPUT_FILE</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">YAML batch file (see examples/)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--parallel</code> <code class="opt-alt">-j</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-help">Number of parallel workers</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--continue-on-error</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--output-file</code> <code class="opt-alt">-o</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li></ul></details></article></div></div></div></section>
|
|
999
|
+
<section class="module" id="query"><header class="module-head"><div class="mod-badge">QY</div><div class="mod-title"><h2>Saved-query library</h2><p class="mod-sub">List / show / save / run / delete reusable filter recipes</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">5 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-query-general">general<span class="chip-count">5</span></a></div><div class="module-body"><div class="grp" id="grp-query-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">5</span></h3><div class="grp-body"><article class="cmd" id="cmd-query-list" data-search="query list list every query under ~/.config/qualys-cli/queries/*.toml." data-mod="query"><header class="cmd-head"><div class="crumbs"><span class="crumb">query</span> <span class='crumb-sep'>›</span> <span class="crumb">list</span></div><code class="cmd-full">qualys-cli query <span class="verb">list</span></code><p class="cmd-summary">List every query under ~/.config/qualys-cli/queries/*.toml.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli query list">qualys-cli query list</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div></article><article class="cmd" id="cmd-query-show" data-search="query show " data-mod="query"><header class="cmd-head"><div class="crumbs"><span class="crumb">query</span> <span class='crumb-sep'>›</span> <span class="crumb">show</span></div><code class="cmd-full">qualys-cli query <span class="verb">show</span></code></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli query show <name>">qualys-cli query show <span class="arg"><name></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-query-save" data-search="query save save the given command tokens as a reusable query." data-mod="query"><header class="cmd-head"><div class="crumbs"><span class="crumb">query</span> <span class='crumb-sep'>›</span> <span class="crumb">save</span></div><code class="cmd-full">qualys-cli query <span class="verb">save</span></code><p class="cmd-summary">Save the given command tokens as a reusable query.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli query save <name> <command>">qualys-cli query save <span class="arg"><name></span> <span class="arg"><command></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">2 required</span> · <span class="cnt-opt">2 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Query name (file-system safe)</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">COMMAND</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Command tokens, e.g. vm host list --ips 10.0.0.0/24</div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--description</code> <code class="opt-alt">-d</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--overwrite</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-query-delete" data-search="query delete " data-mod="query"><header class="cmd-head"><div class="crumbs"><span class="crumb">query</span> <span class='crumb-sep'>›</span> <span class="crumb">delete</span></div><code class="cmd-full">qualys-cli query <span class="verb">delete</span></code></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli query delete <name>">qualys-cli query delete <span class="arg"><name></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li></ul></details></article><article class="cmd" id="cmd-query-run" data-search="query run resolve a saved query and dispatch it." data-mod="query"><header class="cmd-head"><div class="crumbs"><span class="crumb">query</span> <span class='crumb-sep'>›</span> <span class="crumb">run</span></div><code class="cmd-full">qualys-cli query <span class="verb">run</span></code><p class="cmd-summary">Resolve a saved query and dispatch it.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli query run <name>">qualys-cli query run <span class="arg"><name></span></pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-req">1 required</span> · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">NAME</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-req">required</span> <span class="b-arg">positional</span></div><div class="opt-body"></div></li><li class="opt-row"><div class="opt-name"><code class="opt">EXTRA_ARGS</code></div><div class="opt-meta-bar"><span class="b-type">TEXT (repeatable)</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">Additional argv appended after the saved args</div></div></li></ul></details></article></div></div></div></section>
|
|
1000
|
+
<section class="module" id="completion"><header class="module-head"><div class="mod-badge">CO</div><div class="mod-title"><h2>Shell completion</h2><p class="mod-sub">Print bash / zsh / fish / powershell completion scripts</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-completion-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-completion-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-completion" data-search="completion print the completion script for *shell* to stdout — eval / source it." data-mod="completion"><header class="cmd-head"><div class="crumbs"><span class="crumb">completion</span></div><code class="cmd-full">qualys-cli <span class="verb">completion</span></code><p class="cmd-summary">Print the completion script for *shell* to stdout — eval / source it.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli completion">qualys-cli completion</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">SHELL</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span> <span class="b-arg">positional</span></div><div class="opt-body"><div class="opt-help">bash | zsh | fish | powershell</div><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">bash</code></div></div></li></ul></details></article></div></div></div></section>
|
|
1001
|
+
<section class="module" id="cache"><header class="module-head"><div class="mod-badge">CA</div><div class="mod-title"><h2>Response cache</h2><p class="mod-sub">Manage the local ETag-aware SQLite cache</p></div><div class="mod-meta"><span class="auth basic">Local</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-cache-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-cache-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-cache-clear" data-search="cache clear drop every entry from the on-disk response cache." data-mod="cache"><header class="cmd-head"><div class="crumbs"><span class="crumb">cache</span> <span class='crumb-sep'>›</span> <span class="crumb">clear</span></div><code class="cmd-full">qualys-cli cache <span class="verb">clear</span></code><p class="cmd-summary">Drop every entry from the on-disk response cache.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli cache clear">qualys-cli cache clear</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div></article></div></div></div></section>
|
|
1002
|
+
<section class="module" id="mcp"><header class="module-head"><div class="mod-badge">MCP</div><div class="mod-title"><h2>MCP server</h2><p class="mod-sub">Expose every command as an MCP tool over stdio (Claude / Cursor)</p></div><div class="mod-meta"><span class="auth basic">JSON-RPC stdio</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-mcp-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-mcp-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-mcp" data-search="mcp boot a model context protocol server." data-mod="mcp"><header class="cmd-head"><div class="crumbs"><span class="crumb">mcp</span></div><code class="cmd-full">qualys-cli <span class="verb">mcp</span></code><p class="cmd-summary">Boot a Model Context Protocol server.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli mcp">qualys-cli mcp</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">1 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li></ul></details></article></div></div></div></section>
|
|
1003
|
+
<section class="module" id="serve"><header class="module-head"><div class="mod-badge">SV</div><div class="mod-title"><h2>HTTP server</h2><p class="mod-sub">Run a localhost JSON-in / JSON-out HTTP front-end</p></div><div class="mod-meta"><span class="auth basic">Local HTTP</span><span class="mod-count">1 commands</span></div></header><div class="module-toc"><span class="module-toc-label">On this page</span><a class="grp-chip" href="#grp-serve-general">general<span class="chip-count">1</span></a></div><div class="module-body"><div class="grp" id="grp-serve-general"><h3 class="grp-title"><span class="grp-name">general</span><span class="grp-count">1</span></h3><div class="grp-body"><article class="cmd" id="cmd-serve" data-search="serve boot a tiny http server: ``post /run`` runs a cli invocation and returns json." data-mod="serve"><header class="cmd-head"><div class="crumbs"><span class="crumb">serve</span></div><code class="cmd-full">qualys-cli <span class="verb">serve</span></code><p class="cmd-summary">Boot a tiny HTTP server: ``POST /run`` runs a CLI invocation and returns JSON.</p></header><div class="cmd-eg-wrap"><pre class="cmd-eg" data-copy="qualys-cli serve">qualys-cli serve</pre><button class="copy-btn" type="button" aria-label="Copy command" title="Copy">Copy</button></div><details class="opts-toggle"><summary>Options · <span class="cnt-opt">4 optional</span></summary><ul class="opts-list"><li class="opt-row"><div class="opt-name"><code class="opt">--host</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">127.0.0.1</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--port</code></div><div class="opt-meta-bar"><span class="b-type">INTEGER</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">8765</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--profile</code> <code class="opt-alt">-p</code></div><div class="opt-meta-bar"><span class="b-type">TEXT</span></div><div class="opt-body"><div class="opt-meta"><span class="opt-meta-key">Default</span> <code class="chip">default</code></div></div></li><li class="opt-row"><div class="opt-name"><code class="opt">--allow-public-network</code></div><div class="opt-meta-bar"><span class="b-type">FLAG</span></div><div class="opt-body"><div class="opt-help">Required when --host is not a loopback address. There is NO auth on the wire; the server will execute arbitrary qualys-cli commands for anyone who can reach it. Use only behind a firewall + reverse proxy that adds AuthN/Z.</div></div></li></ul></details></article></div></div></div></section>
|
|
1004
|
+
|
|
1005
|
+
</div>
|
|
1006
|
+
</main>
|
|
1007
|
+
|
|
1008
|
+
</div>
|
|
1009
|
+
|
|
1010
|
+
<script>
|
|
1011
|
+
(function(){
|
|
1012
|
+
// ── Filter (search box) ────────────────────────────────────────────────
|
|
1013
|
+
var input = document.getElementById('filter');
|
|
1014
|
+
var body = document.body;
|
|
1015
|
+
var cmds = Array.prototype.slice.call(document.querySelectorAll('.cmd'));
|
|
1016
|
+
var grps = Array.prototype.slice.call(document.querySelectorAll('.grp'));
|
|
1017
|
+
var mods = Array.prototype.slice.call(document.querySelectorAll('section.module'));
|
|
1018
|
+
var sideCmds = Array.prototype.slice.call(document.querySelectorAll('.side-cmd'));
|
|
1019
|
+
var sideGrps = Array.prototype.slice.call(document.querySelectorAll('.side-grp'));
|
|
1020
|
+
var sideMods = Array.prototype.slice.call(document.querySelectorAll('.side-mod'));
|
|
1021
|
+
var sideDoms = Array.prototype.slice.call(document.querySelectorAll('.side-domain'));
|
|
1022
|
+
|
|
1023
|
+
function applyFilter(){
|
|
1024
|
+
var q = input.value.trim().toLowerCase();
|
|
1025
|
+
if (!q){
|
|
1026
|
+
body.classList.remove('filtering');
|
|
1027
|
+
body.classList.remove('no-match');
|
|
1028
|
+
cmds.forEach(function(c){c.classList.remove('match')});
|
|
1029
|
+
grps.forEach(function(g){g.classList.remove('empty')});
|
|
1030
|
+
mods.forEach(function(m){m.classList.remove('empty')});
|
|
1031
|
+
sideCmds.forEach(function(c){c.classList.remove('match')});
|
|
1032
|
+
sideGrps.forEach(function(g){g.classList.remove('empty')});
|
|
1033
|
+
sideMods.forEach(function(m){m.classList.remove('empty')});
|
|
1034
|
+
sideDoms.forEach(function(d){d.classList.remove('empty')});
|
|
1035
|
+
return;
|
|
1036
|
+
}
|
|
1037
|
+
body.classList.add('filtering');
|
|
1038
|
+
var anyMatch = false;
|
|
1039
|
+
cmds.forEach(function(c){
|
|
1040
|
+
var hay = c.getAttribute('data-search') || '';
|
|
1041
|
+
if (hay.indexOf(q) !== -1){
|
|
1042
|
+
c.classList.add('match');
|
|
1043
|
+
anyMatch = true;
|
|
1044
|
+
var d = c.querySelector('details.opts-toggle');
|
|
1045
|
+
if (d) d.open = true;
|
|
1046
|
+
} else {
|
|
1047
|
+
c.classList.remove('match');
|
|
1048
|
+
}
|
|
1049
|
+
});
|
|
1050
|
+
sideCmds.forEach(function(c){
|
|
1051
|
+
var hay = c.getAttribute('data-search') || '';
|
|
1052
|
+
if (hay.indexOf(q) !== -1){ c.classList.add('match'); }
|
|
1053
|
+
else { c.classList.remove('match'); }
|
|
1054
|
+
});
|
|
1055
|
+
grps.forEach(function(g){
|
|
1056
|
+
var any = g.querySelector('.cmd.match');
|
|
1057
|
+
g.classList.toggle('empty', !any);
|
|
1058
|
+
});
|
|
1059
|
+
mods.forEach(function(m){
|
|
1060
|
+
var any = m.querySelector('.cmd.match');
|
|
1061
|
+
m.classList.toggle('empty', !any);
|
|
1062
|
+
});
|
|
1063
|
+
sideGrps.forEach(function(g){
|
|
1064
|
+
var any = g.querySelector('.side-cmd.match');
|
|
1065
|
+
g.classList.toggle('empty', !any);
|
|
1066
|
+
});
|
|
1067
|
+
sideMods.forEach(function(m){
|
|
1068
|
+
var any = m.querySelector('.side-cmd.match');
|
|
1069
|
+
m.classList.toggle('empty', !any);
|
|
1070
|
+
if (any) m.open = true;
|
|
1071
|
+
});
|
|
1072
|
+
// Domain headers: hidden when none of the modules in that domain have a match.
|
|
1073
|
+
// We rely on document order: walk siblings between two .side-domain markers.
|
|
1074
|
+
sideDoms.forEach(function(d){
|
|
1075
|
+
var sib = d.nextElementSibling;
|
|
1076
|
+
var any = false;
|
|
1077
|
+
while (sib && !sib.classList.contains('side-domain')){
|
|
1078
|
+
if (sib.classList && sib.classList.contains('side-mod') && !sib.classList.contains('empty')){
|
|
1079
|
+
any = true; break;
|
|
1080
|
+
}
|
|
1081
|
+
sib = sib.nextElementSibling;
|
|
1082
|
+
}
|
|
1083
|
+
d.classList.toggle('empty', !any);
|
|
1084
|
+
});
|
|
1085
|
+
body.classList.toggle('no-match', !anyMatch);
|
|
1086
|
+
}
|
|
1087
|
+
if (input){
|
|
1088
|
+
input.addEventListener('input', applyFilter);
|
|
1089
|
+
input.addEventListener('keydown', function(e){
|
|
1090
|
+
if (e.key === 'Escape'){ input.value=''; applyFilter(); input.blur(); }
|
|
1091
|
+
});
|
|
1092
|
+
}
|
|
1093
|
+
// "/" focuses the search box from anywhere on the page
|
|
1094
|
+
document.addEventListener('keydown', function(e){
|
|
1095
|
+
var t = e.target;
|
|
1096
|
+
if (t && (t.tagName === 'INPUT' || t.tagName === 'TEXTAREA')) return;
|
|
1097
|
+
if (e.key === '/'){ e.preventDefault(); input.focus(); input.select(); }
|
|
1098
|
+
});
|
|
1099
|
+
|
|
1100
|
+
// ── Copy-to-clipboard on every example block ─────────────────────────
|
|
1101
|
+
document.querySelectorAll('.copy-btn').forEach(function(btn){
|
|
1102
|
+
btn.addEventListener('click', function(){
|
|
1103
|
+
var pre = btn.parentElement.querySelector('.cmd-eg');
|
|
1104
|
+
if (!pre) return;
|
|
1105
|
+
var text = pre.getAttribute('data-copy') || pre.innerText;
|
|
1106
|
+
var ok = function(){
|
|
1107
|
+
var orig = btn.textContent;
|
|
1108
|
+
btn.textContent = 'Copied';
|
|
1109
|
+
btn.classList.add('ok');
|
|
1110
|
+
setTimeout(function(){ btn.textContent = orig; btn.classList.remove('ok'); }, 1200);
|
|
1111
|
+
};
|
|
1112
|
+
if (navigator.clipboard && navigator.clipboard.writeText){
|
|
1113
|
+
navigator.clipboard.writeText(text).then(ok, function(){
|
|
1114
|
+
// fall through to legacy fallback
|
|
1115
|
+
});
|
|
1116
|
+
}
|
|
1117
|
+
// Legacy fallback
|
|
1118
|
+
try{
|
|
1119
|
+
var ta = document.createElement('textarea');
|
|
1120
|
+
ta.value = text; document.body.appendChild(ta); ta.select();
|
|
1121
|
+
document.execCommand('copy'); document.body.removeChild(ta);
|
|
1122
|
+
ok();
|
|
1123
|
+
} catch(err){}
|
|
1124
|
+
});
|
|
1125
|
+
});
|
|
1126
|
+
|
|
1127
|
+
// ── Theme toggle (persisted in localStorage) ─────────────────────────
|
|
1128
|
+
var html = document.documentElement;
|
|
1129
|
+
var themeBtn = document.getElementById('theme-toggle');
|
|
1130
|
+
function setTheme(t){
|
|
1131
|
+
html.setAttribute('data-theme', t);
|
|
1132
|
+
if (themeBtn){
|
|
1133
|
+
themeBtn.textContent = t === 'dark' ? 'Light' : 'Dark';
|
|
1134
|
+
themeBtn.setAttribute('aria-pressed', t === 'dark' ? 'true' : 'false');
|
|
1135
|
+
}
|
|
1136
|
+
try{ localStorage.setItem('qcli-theme', t); } catch(e){}
|
|
1137
|
+
}
|
|
1138
|
+
var savedTheme = null;
|
|
1139
|
+
try{ savedTheme = localStorage.getItem('qcli-theme'); } catch(e){}
|
|
1140
|
+
if (!savedTheme){
|
|
1141
|
+
savedTheme = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches)
|
|
1142
|
+
? 'dark' : 'light';
|
|
1143
|
+
}
|
|
1144
|
+
setTheme(savedTheme);
|
|
1145
|
+
if (themeBtn){
|
|
1146
|
+
themeBtn.addEventListener('click', function(){
|
|
1147
|
+
setTheme(html.getAttribute('data-theme') === 'dark' ? 'light' : 'dark');
|
|
1148
|
+
});
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
// ── Density toggle ────────────────────────────────────────────────────
|
|
1152
|
+
var densityBtn = document.getElementById('density-toggle');
|
|
1153
|
+
function setDensity(d){
|
|
1154
|
+
html.setAttribute('data-density', d);
|
|
1155
|
+
if (densityBtn){
|
|
1156
|
+
densityBtn.textContent = d === 'compact' ? 'Comfortable' : 'Compact';
|
|
1157
|
+
densityBtn.setAttribute('aria-pressed', d === 'compact' ? 'true' : 'false');
|
|
1158
|
+
}
|
|
1159
|
+
try{ localStorage.setItem('qcli-density', d); } catch(e){}
|
|
1160
|
+
}
|
|
1161
|
+
var savedDensity = null;
|
|
1162
|
+
try{ savedDensity = localStorage.getItem('qcli-density'); } catch(e){}
|
|
1163
|
+
setDensity(savedDensity || 'comfortable');
|
|
1164
|
+
if (densityBtn){
|
|
1165
|
+
densityBtn.addEventListener('click', function(){
|
|
1166
|
+
setDensity(html.getAttribute('data-density') === 'compact' ? 'comfortable' : 'compact');
|
|
1167
|
+
});
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
// ── Active section highlight in the sidebar ──────────────────────────
|
|
1171
|
+
var topcrumb = document.getElementById('topcrumb');
|
|
1172
|
+
var sideLinks = Array.prototype.slice.call(document.querySelectorAll('.side-link, .side-mod-sum, .side-cmd, .side-grp-link'));
|
|
1173
|
+
function highlightFromHash(){
|
|
1174
|
+
var id = (location.hash || '').replace(/^#/, '');
|
|
1175
|
+
if (!id) id = 'getting-started';
|
|
1176
|
+
sideLinks.forEach(function(a){a.classList.remove('active')});
|
|
1177
|
+
var sel = document.querySelector('a[href="#' + id + '"], .side-cmd[href="#' + id + '"]');
|
|
1178
|
+
if (sel) sel.classList.add('active');
|
|
1179
|
+
// Update the topbar breadcrumb when the hash points at a command
|
|
1180
|
+
if (id.indexOf('cmd-') === 0){
|
|
1181
|
+
var parts = id.replace(/^cmd-/, '').split('-');
|
|
1182
|
+
topcrumb.innerHTML = '<strong>qualys-cli</strong>' +
|
|
1183
|
+
parts.map(function(p){return ' <span class="crumb-sep">›</span> <span>' + p + '</span>';}).join('');
|
|
1184
|
+
} else if (id.indexOf('grp-') === 0){
|
|
1185
|
+
var s = id.replace(/^grp-/, '').split('-');
|
|
1186
|
+
topcrumb.innerHTML = '<strong>qualys-cli</strong>' +
|
|
1187
|
+
s.map(function(p){return ' <span class="crumb-sep">›</span> <span>' + p + '</span>';}).join('');
|
|
1188
|
+
} else if (id === 'getting-started' || id === 'global-flags' || id === 'security'){
|
|
1189
|
+
topcrumb.innerHTML = '<strong>qualys-cli</strong> <span class="crumb-sep">›</span> <span>Reference</span>';
|
|
1190
|
+
} else {
|
|
1191
|
+
topcrumb.innerHTML = '<strong>qualys-cli</strong> <span class="crumb-sep">›</span> <span>' + id + '</span>';
|
|
1192
|
+
}
|
|
1193
|
+
}
|
|
1194
|
+
window.addEventListener('hashchange', highlightFromHash);
|
|
1195
|
+
highlightFromHash();
|
|
1196
|
+
|
|
1197
|
+
// ── IntersectionObserver: highlight the visible module in the sidebar ─
|
|
1198
|
+
if ('IntersectionObserver' in window){
|
|
1199
|
+
var io = new IntersectionObserver(function(entries){
|
|
1200
|
+
entries.forEach(function(e){
|
|
1201
|
+
if (e.isIntersecting){
|
|
1202
|
+
var id = e.target.id;
|
|
1203
|
+
if (id){
|
|
1204
|
+
var s = document.querySelector('.side-mod[data-mod="' + id + '"]');
|
|
1205
|
+
if (s){
|
|
1206
|
+
document.querySelectorAll('.side-mod.active').forEach(function(x){x.classList.remove('active')});
|
|
1207
|
+
s.classList.add('active');
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
});
|
|
1212
|
+
}, {rootMargin: '-20% 0px -70% 0px'});
|
|
1213
|
+
document.querySelectorAll('section.module').forEach(function(m){io.observe(m)});
|
|
1214
|
+
}
|
|
1215
|
+
|
|
1216
|
+
// ── Auto-open the active module in the sidebar on load ───────────────
|
|
1217
|
+
var openSel = document.querySelector('.side-mod[data-mod="vm"]');
|
|
1218
|
+
if (openSel) openSel.open = true;
|
|
1219
|
+
|
|
1220
|
+
// ── Close mobile menu when a sidebar link is clicked ─────────────────
|
|
1221
|
+
document.querySelectorAll('.sidebar a').forEach(function(a){
|
|
1222
|
+
a.addEventListener('click', function(){
|
|
1223
|
+
if (window.innerWidth < 960) document.body.classList.remove('nav-open');
|
|
1224
|
+
});
|
|
1225
|
+
});
|
|
1226
|
+
})();
|
|
1227
|
+
</script>
|
|
1228
|
+
|
|
1229
|
+
</body>
|
|
1230
|
+
</html>
|