1COBBLER(1) Cobbler COBBLER(1)
2
6 cobbler - Cobbler CLI Documentation
7 This page contains a description for commands which can be used from
9 the CLI.
10 NOTE:
12 We are currently developing a new CLI which is independent from the
13 server. This document redirects you to the new documentation once
14 the new CLI is ready.
15
17 This should just be a brief overview. For the detailed explanations
18 please refer to Readthedocs.
19 Distros, Profiles and Systems
21 Cobbler has a system of inheritance when it comes to managing the in‐
22 formation you want to apply to a certain system.
23 Images
25 Repositories
26 Management Classes
27 Deleting configuration entries
28 If you want to remove a specific object, use the remove command with
29 the name that was used to add it.
30 cobbler distro|profile|system|repo|image|mgmtclass|package|file|menu remove --name=string
32 Editing
34 If you want to change a particular setting without doing an add again,
35 use the edit command, using the same name you gave when you added the
36 item. Anything supplied in the parameter list will overwrite the set‐
37 tings in the existing object, preserving settings not mentioned.
38 cobbler distro|profile|system|repo|image|mgmtclass|package|file|menu edit --name=string [parameterlist]
40 Copying
42 Objects can also be copied:
43 cobbler distro|profile|system|repo|image|mgmtclass|package|file|menu copy --name=oldname --newname=newname
45 Renaming
47 Objects can also be renamed, as long as other objects don't reference
48 them.
49 cobbler distro|profile|system|repo|image|mgmtclass|package|file|menu rename --name=oldname --newname=newname
51
53 Short Usage: cobbler command [subcommand] [--arg1=value1]
54 [--arg2=value2]
55 Long Usage:
57 cobbler <distro|profile|system|repo|image|mgmtclass|package|file|menu> ... [add|edit|copy|get-autoinstall*|list|remove|rename|report] [options|--help]
59 cobbler <aclsetup|buildiso|import|list|mkloaders|replicate|report|reposync|sync|validate-autoinstalls|version|signature|hardlink> [options|--help]
60 Cobbler distro
62 This first step towards configuring what you want to install is to add
63 a distribution record to Cobbler's configuration.
64 If there is an rsync mirror, DVD, NFS, or filesystem tree available
66 that you would rather import instead, skip down to the documentation
67 about the import command. It's really a lot easier to follow the import
68 workflow -- it only requires waiting for the mirror content to be
69 copied and/or scanned. Imported mirrors also save time during install
70 since they don't have to hit external install sources.
71 If you want to be explicit with distribution definition, however,
73 here's how it works:
74 $ cobbler distro add --name=string --kernel=path --initrd=path [--kernel-options=string] [--kernel-options-post=string] [--autoinstall-meta=string] [--arch=i386|x86_64|ppc|ppc64|ppc64le|arm64] [--breed=redhat|debian|suse] [--template-files=string]
76 ┌───────────────────────┬────────────────────────────┐
78 │Name │ Description │
79 ├───────────────────────┼────────────────────────────┤
80 │arch │ Sets the architecture for │
81 │ │ the PXE bootloader and │
82 │ │ also controls how Koan's │
83 │ │ --replace-self option will │
84 │ │ operate. │
85 │ │ │
86 │ │ The default setting (stan‐ │
87 │ │ dard) will use pxelinux. │
88 │ │ │
89 │ │ x86 and x86_64 effectively │
90 │ │ do the same thing as stan‐ │
91 │ │ dard. │
92 │ │ │
93 │ │ If you perform a cobbler │
94 │ │ import, the arch field │
95 │ │ will be auto-assigned. │
96 ├───────────────────────┼────────────────────────────┤
97 │autoinstall- meta │ This is an advanced fea‐ │
98 │ │ ture that sets automatic │
99 │ │ installation template │
100 │ │ variables to substitute, │
101 │ │ thus enabling those files │
102 │ │ to be treated as tem‐ │
103 │ │ plates. Templates are pow‐ │
104 │ │ ered using Cheetah and are │
105 │ │ described further along in │
106 │ │ this manpage as well as on │
107 │ │ the Cobbler Wiki. │
108 │ │ │
109 │ │ Example: --autoin‐ │
110 │ │ stall-meta="foo=bar baz=3 │
111 │ │ asdf" │
112 │ │ │
113 │ │ See the section on "Kick‐ │
114 │ │ start Templating" for fur‐ │
115 │ │ ther information. │
116 ├───────────────────────┼────────────────────────────┤
117 │boot-files │ TFTP Boot Files (Files │
118 │ │ copied into tftpboot be‐ │
119 │ │ yond the kernel/initrd). │
120 ├───────────────────────┼────────────────────────────┤
121 │boot-loaders │ Boot loader space delim‐ │
122 │ │ ited list (Network instal‐ │
123 │ │ lation boot loaders). │
124 │ │ Valid options for list │
125 │ │ items are <<inherit>>, │
126 │ │ grub, pxe, ipxe. │
127 └───────────────────────┴────────────────────────────┘
128 │breed │ Controls how various phys‐ │
134 │ │ ical and virtual parame‐ │
135 │ │ ters, including kernel ar‐ │
136 │ │ guments for automatic in‐ │
137 │ │ stallation, are to be │
138 │ │ treated. Defaults to red‐ │
139 │ │ hat, which is a suitable │
140 │ │ value for Fedora and Cen‐ │
141 │ │ tOS as well. It means any‐ │
142 │ │ thing Red Hat based. │
143 │ │ │
144 │ │ There is limited experi‐ │
145 │ │ mental support for speci‐ │
146 │ │ fying "debian", "ubuntu", │
147 │ │ or "suse", which treats │
148 │ │ the automatic installation │
149 │ │ template file as a pre‐ │
150 │ │ seed/autoyast file format │
151 │ │ and changes the kernel ar‐ │
152 │ │ guments appropriately. │
153 │ │ Support for other types of │
154 │ │ distributions is possible │
155 │ │ in the future. See the │
156 │ │ Wiki for the latest infor‐ │
157 │ │ mation about support for │
158 │ │ these distributions. │
159 │ │ │
160 │ │ The file used for the an‐ │
161 │ │ swer file, regardless of │
162 │ │ the breed setting, is the │
163 │ │ value used for --autoin‐ │
164 │ │ stall when creating the │
165 │ │ profile. │
166 ├───────────────────────┼────────────────────────────┤
167 │comment │ Simple attach a descrip‐ │
168 │ │ tion (Free form text) to │
169 │ │ your distro. │
170 ├───────────────────────┼────────────────────────────┤
171 │fetchable-files │ Fetchable Files (Templates │
172 │ │ for tftp or wget/curl) │
173 ├───────────────────────┼────────────────────────────┤
174 │initrd │ An absolute filesystem │
175 │ │ path to a initrd image. │
176 ├───────────────────────┼────────────────────────────┤
177 │kernel │ An absolute filesystem │
178 │ │ path to a kernel image. │
179 └───────────────────────┴────────────────────────────┘
180 │kernel-options │ Sets kernel command-line │
200 │ │ arguments that the distro, │
201 │ │ and profiles/systems de‐ │
202 │ │ pending on it, will use. │
203 │ │ To remove a kernel argu‐ │
204 │ │ ment that may be added by │
205 │ │ a higher Cobbler object │
206 │ │ (or in the global set‐ │
207 │ │ tings), you can prefix it │
208 │ │ with a !. │
209 │ │ │
210 │ │ Example: --kernel-op‐ │
211 │ │ tions="foo=bar baz=3 asdf │
212 │ │ !gulp" │
213 │ │ │
214 │ │ This example passes the │
215 │ │ arguments foo=bar baz=3 │
216 │ │ asdf but will make sure │
217 │ │ gulp is not passed even if │
218 │ │ it was requested at a │
219 │ │ level higher up in the │
220 │ │ Cobbler configuration. │
221 ├───────────────────────┼────────────────────────────┤
222 │kernel-options- post │ This is just like --ker‐ │
223 │ │ nel-options, though it │
224 │ │ governs kernel options on │
225 │ │ the installed OS, as op‐ │
226 │ │ posed to kernel options │
227 │ │ fed to the installer. The │
228 │ │ syntax is exactly the │
229 │ │ same. This requires some │
230 │ │ special snippets to be │
231 │ │ found in your automatic │
232 │ │ installation template in │
233 │ │ order for this to work. │
234 │ │ Automatic installation │
235 │ │ templating is described │
236 │ │ later on in this document. │
237 │ │ │
238 │ │ Example: noapic │
239 ├───────────────────────┼────────────────────────────┤
240 │mgmt-classes │ Management Classes (Man‐ │
241 │ │ agement classes for exter‐ │
242 │ │ nal config management). │
243 ├───────────────────────┼────────────────────────────┤
244 │name │ A string identifying the │
245 │ │ distribution, this should │
246 │ │ be something like rhel6. │
247 └───────────────────────┴────────────────────────────┘
248 │os-version │ Generally this field can │
266 │ │ be ignored. It is intended │
267 │ │ to alter some hardware │
268 │ │ setup for virtualized in‐ │
269 │ │ stances when provisioning │
270 │ │ guests with Koan. The │
271 │ │ valid options for │
272 │ │ --os-version vary depend‐ │
273 │ │ ing on what is specified │
274 │ │ for --breed. If you spec‐ │
275 │ │ ify an invalid option, the │
276 │ │ error message will contain │
277 │ │ a list of valid OS ver‐ │
278 │ │ sions that can be used. If │
279 │ │ you don't know the OS ver‐ │
280 │ │ sion or it does not appear │
281 │ │ in the list, omitting this │
282 │ │ argument or using other │
283 │ │ should be perfectly fine. │
284 │ │ If you don't encounter any │
285 │ │ problems with virtualized │
286 │ │ instances, this option can │
287 │ │ be safely ignored. │
288 ├───────────────────────┼────────────────────────────┤
289 │owners │ Users with small sites and │
290 │ │ a limited number of admins │
291 │ │ can probably ignore this │
292 │ │ option. All Cobbler ob‐ │
293 │ │ jects (distros, profiles, │
294 │ │ systems, and repos) can │
295 │ │ take a --owners parameter │
296 │ │ to specify what Cobbler │
297 │ │ users can edit particular │
298 │ │ objects.This only applies │
299 │ │ to the Cobbler WebUI and │
300 │ │ XML-RPC interface, not the │
301 │ │ "cobbler" command line │
302 │ │ tool run from the shell. │
303 │ │ Furthermore, this is only │
304 │ │ respected by the au‐ │
305 │ │ thz_ownership module which │
306 │ │ must be enabled in │
307 │ │ /etc/cobbler/modules.conf. │
308 │ │ The value for --owners is │
309 │ │ a space separated list of │
310 │ │ users and groups as speci‐ │
311 │ │ fied in /etc/cob‐ │
312 │ │ bler/users.conf. For more │
313 │ │ information see the │
314 │ │ users.conf file as well as │
315 │ │ the Cobbler Wiki. In the │
316 │ │ default Cobbler configura‐ │
317 │ │ tion, this value is com‐ │
318 │ │ pletely ignored, as is │
319 │ │ users.conf. │
320 ├───────────────────────┼────────────────────────────┤
321 │redhat- management-key │ Management Classes (Man‐ │
322 │ │ agement classes for exter‐ │
323 │ │ nal config management). │
324 └───────────────────────┴────────────────────────────┘
325 │remote-boot- kernel │ A URL pointing to the in‐ │
332 │ │ stallation initrd of a │
333 │ │ distribution. If the boot‐ │
334 │ │ loader has this support, │
335 │ │ it will directly download │
336 │ │ the kernel from this URL, │
337 │ │ instead of the directory │
338 │ │ of the TFTP client. Note: │
339 │ │ The kernel (or initrd be‐ │
340 │ │ low) will still be copied │
341 │ │ into the image directory │
342 │ │ of the TFTP server. The │
343 │ │ above kernel parameter is │
344 │ │ still needed (e.g. to │
345 │ │ build iso images, etc.). │
346 │ │ The advantage of letting │
347 │ │ the boot loader retrieve │
348 │ │ the kernel/initrd directly │
349 │ │ is the support of chang‐ │
350 │ │ ing/updated distributions. │
351 │ │ E.g. openSUSE Tumbleweed │
352 │ │ is updated on the fly and │
353 │ │ if Cobbler would │
354 │ │ copy/cache the kernel/ini‐ │
355 │ │ trd in the TFTP directory, │
356 │ │ you would get a "kernel │
357 │ │ does not match distribu‐ │
358 │ │ tion" (or similar) error │
359 │ │ when trying to install. │
360 ├───────────────────────┼────────────────────────────┤
361 │remote-boot- initrd │ See remote-boot-kernel │
362 │ │ above. │
363 ├───────────────────────┼────────────────────────────┤
364 │template-files │ This feature allows Cob‐ │
365 │ │ bler to be used as a con‐ │
366 │ │ figuration management sys‐ │
367 │ │ tem. The argument is a │
368 │ │ space delimited string of │
369 │ │ key=value pairs. Each key │
370 │ │ is the path to a template │
371 │ │ file, each value is the │
372 │ │ path to install the file │
373 │ │ on the system. This is de‐ │
374 │ │ scribed in further detail │
375 │ │ on the Cobbler Wiki and is │
376 │ │ implemented using special │
377 │ │ code in the post install. │
378 │ │ Koan also can retrieve │
379 │ │ these files from a Cobbler │
380 │ │ server on demand, effec‐ │
381 │ │ tively allowing Cobbler to │
382 │ │ function as a lightweight │
383 │ │ templated configuration │
384 │ │ management system. │
385 └───────────────────────┴────────────────────────────┘
386 Cobbler profile
388 A profile associates a distribution to additional specialized options,
389 such as a installation automation file. Profiles are the core unit of
390 provisioning and at least one profile must exist for every distribution
391 to be provisioned. A profile might represent, for instance, a web
392 server or desktop configuration. In this way, profiles define a role to
393 be performed.
394 $ cobbler profile add --name=string --distro=string [--autoinstall=path] [--kernel-options=string] [--autoinstall-meta=string] [--name-servers=string] [--name-servers-search=string] [--virt-file-size=gigabytes] [--virt-ram=megabytes] [--virt-type=string] [--virt-cpus=integer] [--virt-path=string] [--virt-bridge=string] [--server] [--parent=profile] [--filename=string]
396 Arguments are the same as listed for distributions, save for the re‐
398 moval of "arch" and "breed", and with the additions listed below:
399 ┌───────────────────────┬────────────────────────────┐
401 │Name │ Description │
402 ├───────────────────────┼────────────────────────────┤
403 │autoinstall │ Local filesystem path to a │
404 │ │ automatic installation │
405 │ │ file, the file must reside │
406 │ │ under /var/lib/cob‐ │
407 │ │ bler/templates │
408 ├───────────────────────┼────────────────────────────┤
409 │autoinstall-meta │ Automatic Installation │
410 │ │ Metadata (Ex: dog=fang │
411 │ │ agent=86). │
412 ├───────────────────────┼────────────────────────────┤
413 │boot-files │ TFTP Boot Files (Files │
414 │ │ copied into tftpboot be‐ │
415 │ │ yond the kernel/initrd). │
416 ├───────────────────────┼────────────────────────────┤
417 │boot-loaders │ Boot loader space delim‐ │
418 │ │ ited list (Network instal‐ │
419 │ │ lation boot loaders). │
420 │ │ Valid options for list │
421 │ │ items are <<inherit>>, │
422 │ │ grub, pxe, ipxe. │
423 ├───────────────────────┼────────────────────────────┤
424 │comment │ Simple attach a descrip‐ │
425 │ │ tion (Free form text) to │
426 │ │ your distro. │
427 ├───────────────────────┼────────────────────────────┤
428 │dhcp-tag │ DHCP Tag (see description │
429 │ │ in system). │
430 ├───────────────────────┼────────────────────────────┤
431 │distro │ The name of a previously │
432 │ │ defined Cobbler distribu‐ │
433 │ │ tion. This value is re‐ │
434 │ │ quired. │
435 ├───────────────────────┼────────────────────────────┤
436 │enable-ipxe │ Enable iPXE? (Use iPXE in‐ │
437 │ │ stead of PXELINUX for ad‐ │
438 │ │ vanced booting options) │
439 ├───────────────────────┼────────────────────────────┤
440 │enable-menu │ Enable PXE Menu? (Show │
441 │ │ this profile in the PXE │
442 │ │ menu?) │
443 ├───────────────────────┼────────────────────────────┤
444 │fetchable-files │ Fetchable Files (Templates │
445 │ │ for tftp or wget/curl) │
446 ├───────────────────────┼────────────────────────────┤
447 │filename │ This parameter can be used │
448 │ │ to select the bootloader │
449 │ │ for network boot. If spec‐ │
450 │ │ ified, this must be a path │
451 │ │ relative to the TFTP │
452 │ │ servers root directory. │
453 │ │ (e.g. grub/grubx64.efi) │
454 │ │ For most use cases the de‐ │
455 │ │ fault bootloader is cor‐ │
456 │ │ rect and this can be omit‐ │
457 │ │ ted │
458 └───────────────────────┴────────────────────────────┘
459 │menu │ This is a way of organiz‐ │
464 │ │ ing profiles and images in │
465 │ │ an automatically generated │
466 │ │ boot menu for grub, pxe │
467 │ │ and ipxe boot loaders. │
468 │ │ Menu created with cobbler │
469 │ │ menu add command. │
470 ├───────────────────────┼────────────────────────────┤
471 │name │ A descriptive name. This │
472 │ │ could be something like │
473 │ │ rhel5webservers or f9desk‐ │
474 │ │ tops. │
475 ├───────────────────────┼────────────────────────────┤
476 │name-servers │ If your nameservers are │
477 │ │ not provided by DHCP, you │
478 │ │ can specify a space sepa‐ │
479 │ │ rated list of addresses │
480 │ │ here to configure each of │
481 │ │ the installed nodes to use │
482 │ │ them (provided the auto‐ │
483 │ │ matic installation files │
484 │ │ used are installed on a │
485 │ │ per-system basis). Users │
486 │ │ with DHCP setups should │
487 │ │ not need to use this op‐ │
488 │ │ tion. This is available to │
489 │ │ set in profiles to avoid │
490 │ │ having to set it repeat‐ │
491 │ │ edly for each system │
492 │ │ record. │
493 ├───────────────────────┼────────────────────────────┤
494 │name-servers-search │ You can specify a space │
495 │ │ separated list of domain │
496 │ │ names to configure each of │
497 │ │ the installed nodes to use │
498 │ │ them as domain search │
499 │ │ path. This is available to │
500 │ │ set in profiles to avoid │
501 │ │ having to set it repeat‐ │
502 │ │ edly for each system │
503 │ │ record. │
504 ├───────────────────────┼────────────────────────────┤
505 │next-server │ To override the Next │
506 │ │ server. │
507 └───────────────────────┴────────────────────────────┘
508 │owners │ Users with small sites and │
530 │ │ a limited number of admins │
531 │ │ can probably ignore this │
532 │ │ option. All objects (dis‐ │
533 │ │ tros, profiles, systems, │
534 │ │ and repos) can take a │
535 │ │ --owners parameter to │
536 │ │ specify what Cobbler users │
537 │ │ can edit particular ob‐ │
538 │ │ jects.This only applies to │
539 │ │ the Cobbler WebUI and │
540 │ │ XML-RPC interface, not the │
541 │ │ "cobbler" command line │
542 │ │ tool run from the shell. │
543 │ │ Furthermore, this is only │
544 │ │ respected by the au‐ │
545 │ │ thz_ownership module which │
546 │ │ must be enabled in │
547 │ │ /etc/cobbler/modules.conf. │
548 │ │ The value for --owners is │
549 │ │ a space separated list of │
550 │ │ users and groups as speci‐ │
551 │ │ fied in /etc/cob‐ │
552 │ │ bler/users.conf. For more │
553 │ │ information see the │
554 │ │ users.conf file as well as │
555 │ │ the Cobbler Wiki. In the │
556 │ │ default Cobbler configura‐ │
557 │ │ tion, this value is com‐ │
558 │ │ pletely ignored, as is │
559 │ │ users.conf. │
560 └───────────────────────┴────────────────────────────┘
561 │parent │ This is an advanced fea‐ │
596 │ │ ture. │
597 │ │ │
598 │ │ Profiles may inherit from │
599 │ │ other profiles in lieu of │
600 │ │ specifying --distro. In‐ │
601 │ │ herited profiles will │
602 │ │ override any settings │
603 │ │ specified in their parent, │
604 │ │ with the exception of │
605 │ │ --autoinstall-meta (tem‐ │
606 │ │ plating) and --kernel-op‐ │
607 │ │ tions (kernel options), │
608 │ │ which will be blended to‐ │
609 │ │ gether. │
610 │ │ │
611 │ │ Example: If profile A has │
612 │ │ --kernel-options="x=7 │
613 │ │ y=2", B inherits from A, │
614 │ │ and B has --kernel-op‐ │
615 │ │ tions="x=9 z=2", the ac‐ │
616 │ │ tual kernel options that │
617 │ │ will be used for B are x=9 │
618 │ │ y=2 z=2. │
619 │ │ │
620 │ │ Example: If profile B has │
621 │ │ --virt-ram=256 and A has │
622 │ │ --virt-ram=512, profile B │
623 │ │ will use the value 256. │
624 │ │ │
625 │ │ Example: If profile A has │
626 │ │ a --virt-file-size=5 and B │
627 │ │ does not specify a size, B │
628 │ │ will use the value from A. │
629 ├───────────────────────┼────────────────────────────┤
630 │proxy │ Proxy URL. │
631 ├───────────────────────┼────────────────────────────┤
632 │redhat- management-key │ Management Classes (Man‐ │
633 │ │ agement classes for exter‐ │
634 │ │ nal config management). │
635 ├───────────────────────┼────────────────────────────┤
636 │repos │ This is a space delimited │
637 │ │ list of all the repos │
638 │ │ (created with cobbler repo │
639 │ │ add and updated with cob‐ │
640 │ │ bler reposync)that this │
641 │ │ profile can make use of │
642 │ │ during automated installa‐ │
643 │ │ tion. For example, an ex‐ │
644 │ │ ample might be --re‐ │
645 │ │ pos="fc6i386updates │
646 │ │ fc6i386extras" if the pro‐ │
647 │ │ file wants to access these │
648 │ │ two mirrors that are al‐ │
649 │ │ ready mirrored on the Cob‐ │
650 │ │ bler server. Repo manage‐ │
651 │ │ ment is described in │
652 │ │ greater depth later in the │
653 │ │ manpage. │
654 └───────────────────────┴────────────────────────────┘
655 │server │ This parameter should be │
662 │ │ useful only in select cir‐ │
663 │ │ cumstances. If machines │
664 │ │ are on a subnet that can‐ │
665 │ │ not access the Cobbler │
666 │ │ server using the name/IP │
667 │ │ as configured in the Cob‐ │
668 │ │ bler settings file, use │
669 │ │ this parameter to override │
670 │ │ that servername. See also │
671 │ │ --dhcp-tag for configuring │
672 │ │ the next server and DHCP │
673 │ │ information of the system │
674 │ │ if you are also using Cob‐ │
675 │ │ bler to help manage your │
676 │ │ DHCP configuration. │
677 ├───────────────────────┼────────────────────────────┤
678 │template-files │ This feature allows Cob‐ │
679 │ │ bler to be used as a con‐ │
680 │ │ figuration management sys‐ │
681 │ │ tem. The argument is a │
682 │ │ space delimited string of │
683 │ │ key=value pairs. Each key │
684 │ │ is the path to a template │
685 │ │ file, each value is the │
686 │ │ path to install the file │
687 │ │ on the system. This is de‐ │
688 │ │ scribed in further detail │
689 │ │ on the Cobbler Wiki and is │
690 │ │ implemented using special │
691 │ │ code in the post install. │
692 │ │ Koan also can retrieve │
693 │ │ these files from a Cobbler │
694 │ │ server on demand, effec‐ │
695 │ │ tively allowing Cobbler to │
696 │ │ function as a lightweight │
697 │ │ templated configuration │
698 │ │ management system. │
699 ├───────────────────────┼────────────────────────────┤
700 │virt-auto-boot │ (Virt-only) Virt Auto Boot │
701 │ │ (Auto boot this VM?). │
702 ├───────────────────────┼────────────────────────────┤
703 │virt-bridge │ (Virt-only) This specifies │
704 │ │ the default bridge to use │
705 │ │ for all systems defined │
706 │ │ under this profile. If not │
707 │ │ specified, it will assume │
708 │ │ the default value in the │
709 │ │ Cobbler settings file, │
710 │ │ which as shipped in the │
711 │ │ RPM is xenbr0. If using │
712 │ │ KVM, this is most likely │
713 │ │ not correct. You may want │
714 │ │ to override this setting │
715 │ │ in the system object. │
716 │ │ Bridge settings are impor‐ │
717 │ │ tant as they define how │
718 │ │ outside networking will │
719 │ │ reach the guest. For more │
720 │ │ information on bridge │
721 │ │ setup, see the Cobbler │
722 │ │ Wiki, where there is a │
723 │ │ section describing Koan │
724 │ │ usage. │
725 └───────────────────────┴────────────────────────────┘
726 │virt-cpus │ (Virt-only) How many vir‐ │
728 │ │ tual CPUs should Koan give │
729 │ │ the virtual machine? The │
730 │ │ default is 1. This is an │
731 │ │ integer. │
732 ├───────────────────────┼────────────────────────────┤
733 │virt-disk-driver │ (Virt-only) Virt Disk │
734 │ │ Driver Type (The on-disk │
735 │ │ format for the virtualiza‐ │
736 │ │ tion disk). Valid options │
737 │ │ are <<inherit>>, raw, │
738 │ │ qcow2, qed, vdi, vmdk │
739 ├───────────────────────┼────────────────────────────┤
740 │virt-file-size │ (Virt-only) How large the │
741 │ │ disk image should be in │
742 │ │ Gigabytes. The default is │
743 │ │ 5. This can be a comma │
744 │ │ separated list (ex: 5,6,7) │
745 │ │ to allow for multiple │
746 │ │ disks of different sizes │
747 │ │ depending on what is given │
748 │ │ to --virt-path. This │
749 │ │ should be input as a inte‐ │
750 │ │ ger or decimal value with‐ │
751 │ │ out units. │
752 ├───────────────────────┼────────────────────────────┤
753 │virt-path │ (Virt-only) Where to store │
754 │ │ the virtual image on the │
755 │ │ host system. Except for │
756 │ │ advanced cases, this pa‐ │
757 │ │ rameter can usually be │
758 │ │ omitted. For disk images, │
759 │ │ the value is usually an │
760 │ │ absolute path to an exist‐ │
761 │ │ ing directory with an op‐ │
762 │ │ tional filename component. │
763 │ │ There is support for spec‐ │
764 │ │ ifying partitions │
765 │ │ /dev/sda4 or volume groups │
766 │ │ VolGroup00, etc. │
767 │ │ │
768 │ │ For multiple disks, sepa‐ │
769 │ │ rate the values with com‐ │
770 │ │ mas such as Vol‐ │
771 │ │ Group00,VolGroup00 or │
772 │ │ /dev/sda4,/dev/sda5. Both │
773 │ │ those examples would cre‐ │
774 │ │ ate two disks for the VM. │
775 ├───────────────────────┼────────────────────────────┤
776 │virt-ram │ (Virt-only) How many │
777 │ │ megabytes of RAM to con‐ │
778 │ │ sume. The default is 512 │
779 │ │ MB. This should be input │
780 │ │ as an integer without │
781 │ │ units. │
782 └───────────────────────┴────────────────────────────┘
783 │virt-type │ (Virt-only) Koan can in‐ │
794 │ │ stall images using either │
795 │ │ Xen paravirt (xenpv) or │
796 │ │ QEMU/KVM (qemu). Choose │
797 │ │ one or the other strings │
798 │ │ to specify, or values will │
799 │ │ default to attempting to │
800 │ │ find a compatible instal‐ │
801 │ │ lation type on the client │
802 │ │ system("auto"). See the │
803 │ │ "Koan" manpage for more │
804 │ │ documentation. The default │
805 │ │ --virt-type can be config‐ │
806 │ │ ured in the Cobbler set‐ │
807 │ │ tings file such that this │
808 │ │ parameter does not have to │
809 │ │ be provided. Other virtu‐ │
810 │ │ alization types are sup‐ │
811 │ │ ported, for information on │
812 │ │ those options (such as │
813 │ │ VMware), see the Cobbler │
814 │ │ Wiki. │
815 └───────────────────────┴────────────────────────────┘
816 Cobbler system
818 System records map a piece of hardware (or a virtual machine) with the
819 Cobbler profile to be assigned to run on it. This may be thought of as
820 choosing a role for a specific system.
821 Note that if provisioning via Koan and PXE menus alone, it is not re‐
823 quired to create system records in Cobbler, though they are useful when
824 system specific customizations are required. One such customization
825 would be defining the MAC address. If there is a specific role intended
826 for a given machine, system records should be created for it.
827 System commands have a wider variety of control offered over network
829 details. In order to use these to the fullest possible extent, the au‐
830 tomatic installation template used by Cobbler must contain certain au‐
831 tomatic installation snippets (sections of code specifically written
832 for Cobbler to make these values become reality). Compare your auto‐
833 matic installation templates with the stock ones in /var/lib/cob‐
834 bler/templates if you have upgraded, to make sure you can take advan‐
835 tage of all options to their fullest potential. If you are a new Cob‐
836 bler user, base your automatic installation templates off of these tem‐
837 plates.
838 Read more about networking setup at:
840 https://cobbler.readthedocs.io/en/release28/4_advanced/advanced%20networking.html
841 Example:
843 $ cobbler system add --name=string --profile=string [--mac=macaddress] [--ip-address=ipaddress] [--hostname=hostname] [--kernel-options=string] [--autoinstall-meta=string] [--autoinstall=path] [--netboot-enabled=Y/N] [--server=string] [--gateway=string] [--dns-name=string] [--static-routes=string] [--power-address=string] [--power-type=string] [--power-user=string] [--power-pass=string] [--power-id=string]
845 Adds a Cobbler System to the configuration. Arguments are specified as
847 per "profile add" with the following changes:
848┌───────────────────────────┬────────────────────────────────────────────────────────────────────┐
850│Name │ Description │
851└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
852│autoinstall │ While it is recommended │
860│ │ that the --autoinstall pa‐ │
861│ │ rameter is only used │
862│ │ within for the "profile │
863│ │ add" command, there are │
864│ │ limited scenarios when an │
865│ │ install base switching to │
866│ │ Cobbler may have legacy │
867│ │ automatic installation │
868│ │ files created on aper-sys‐ │
869│ │ tem basis (one automatic │
870│ │ installation file for each │
871│ │ system, nothing shared) │
872│ │ and may not want to imme‐ │
873│ │ diately make use of the │
874│ │ Cobbler templating system. │
875│ │ This allows specifying a │
876│ │ automatic installation │
877│ │ file for use on a per-sys‐ │
878│ │ tem basis. Creation of a │
879│ │ parent profile is still │
880│ │ required. If the automatic │
881│ │ installation file is a │
882│ │ filesystem location, it │
883│ │ will still be treated as a │
884│ │ Cobbler template. │
885├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
886│autoinstall-meta │ Automatic Installation │
887│ │ Metadata (Ex: dog=fang │
888│ │ agent=86). │
889├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
890│boot-files │ TFTP Boot Files (Files │
891│ │ copied into tftpboot be‐ │
892│ │ yond the kernel/initrd). │
893├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
894│boot-loaders │ Boot loader space delim‐ │
895│ │ ited list (Network instal‐ │
896│ │ lation boot loaders). │
897│ │ Valid options for list │
898│ │ items are <<inherit>>, │
899│ │ grub, pxe, ipxe. │
900├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
901│comment │ Simple attach a descrip‐ │
902│ │ tion (Free form text) to │
903│ │ your distro. │
904└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
905│dhcp-tag │ If you are setting up a │
926│ │ PXE environment with mul‐ │
927│ │ tiple subnets/gateways, │
928│ │ and are using Cobbler to │
929│ │ manage a DHCP configura‐ │
930│ │ tion, you will probably │
931│ │ want to use this option. │
932│ │ If not, it can be ignored. │
933│ │ │
934│ │ By default, the dhcp tag │
935│ │ for all systems is "de‐ │
936│ │ fault" and means that in │
937│ │ the DHCP template files │
938│ │ the systems will expand │
939│ │ out where $insert_cob‐ │
940│ │ bler_systems_definitions │
941│ │ is found in the DHCP tem‐ │
942│ │ plate. However, you may │
943│ │ want certain systems to │
944│ │ expand out in other places │
945│ │ in the DHCP config file. │
946│ │ Setting --dhcp-tag=subnet2 │
947│ │ for instance, will cause │
948│ │ that system to expand out │
949│ │ where $insert_cobbler_sys‐ │
950│ │ tem_definitions_subnet2 is │
951│ │ found, allowing you to in‐ │
952│ │ sert directives to specify │
953│ │ different subnets (or │
954│ │ other parameters) before │
955│ │ the DHCP configuration en‐ │
956│ │ tries for those particular │
957│ │ systems. │
958│ │ │
959│ │ This is described further │
960│ │ on the Cobbler Wiki. │
961├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
962│dns-name │ If using the DNS manage‐ │
963│ │ ment feature (see advanced │
964│ │ section -- Cobbler sup‐ │
965│ │ ports auto-setup of BIND │
966│ │ and dnsmasq), use this to │
967│ │ define a hostname for the │
968│ │ system to receive from │
969│ │ DNS. │
970│ │ │
971│ │ Example: --dns-name=mycom‐ │
972│ │ puter.example.com │
973│ │ │
974│ │ This is a per-interface │
975│ │ parameter. If you have │
976│ │ multiple interfaces, it │
977│ │ may be different for each │
978│ │ interface, for example, │
979│ │ assume a DMZ / dual-homed │
980│ │ setup. │
981├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
982│enable-ipxe │ Enable iPXE? (Use iPXE in‐ │
983│ │ stead of PXELINUX for ad‐ │
984│ │ vanced booting options) │
985├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
986│fetchable-files │ Fetchable Files (Templates │
987│ │ for tftp or wget/curl) │
988└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
989│filename │ This parameter can be used │
992│ │ to select the bootloader │
993│ │ for network boot. If spec‐ │
994│ │ ified, this must be a path │
995│ │ relative to the TFTP │
996│ │ servers root directory. │
997│ │ (e.g. grub/grubx64.efi) │
998│ │ For most use cases the de‐ │
999│ │ fault bootloader is cor‐ │
1000│ │ rect and this can be omit‐ │
1001│ │ ted │
1002├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1003│gateway and netmask │ If you are using static IP │
1004│ │ configurations and the in‐ │
1005│ │ terface is flagged │
1006│ │ --static=1, these will be │
1007│ │ applied. │
1008│ │ │
1009│ │ Netmask is a per-interface │
1010│ │ parameter. Because of the │
1011│ │ way gateway is stored on │
1012│ │ the installed OS, gateway │
1013│ │ is a global parameter. You │
1014│ │ may use --static-routes │
1015│ │ for per-interface cus‐ │
1016│ │ tomizations if required. │
1017├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1018│hostname │ This field corresponds to │
1019│ │ the hostname set in a sys‐ │
1020│ │ tems /etc/sysconfig/net‐ │
1021│ │ work file. This has no │
1022│ │ bearing on DNS, even when │
1023│ │ manage_dns is enabled. Use │
1024│ │ --dns-name instead for │
1025│ │ that feature. │
1026│ │ │
1027│ │ This parameter is assigned │
1028│ │ once per system, it is not │
1029│ │ a per-interface setting. │
1030└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1031│interface │ By default flags like │
1058│ │ --ip, --mac, --dhcp-tag, │
1059│ │ --dns-name, --netmask, │
1060│ │ --virt-bridge, and │
1061│ │ --static-routes operate on │
1062│ │ the first network inter‐ │
1063│ │ face defined for a system │
1064│ │ (eth0). However, Cobbler │
1065│ │ supports an arbitrary num‐ │
1066│ │ ber of interfaces. Using │
1067│ │ --interface=eth1 for in‐ │
1068│ │ stance, will allow creat‐ │
1069│ │ ing and editing of a sec‐ │
1070│ │ ond interface. │
1071│ │ │
1072│ │ Interface naming notes: │
1073│ │ │
1074│ │ Additional interfaces can │
1075│ │ be specified (for example: │
1076│ │ eth1, or any name you │
1077│ │ like, as long as it does │
1078│ │ not conflict with any re‐ │
1079│ │ served names such as ker‐ │
1080│ │ nel module names) for use │
1081│ │ with the edit command. │
1082│ │ Defining VLANs this way is │
1083│ │ also supported, of you │
1084│ │ want to add VLAN 5 on in‐ │
1085│ │ terface eth0, simply name │
1086│ │ your interface eth0.5. │
1087│ │ │
1088│ │ Example: │
1089│ │ │
1090│ │ cobbler system edit │
1091│ │ --name=foo --ip-ad‐ │
1092│ │ dress=192.168.1.50 │
1093│ │ --mac=AA:BB:CC:DD:EE:A0 │
1094│ │ │
1095│ │ cobbler system edit │
1096│ │ --name=foo --inter‐ │
1097│ │ face=eth0 --ip-ad‐ │
1098│ │ dress=10.1.1.51 │
1099│ │ --mac=AA:BB:CC:DD:EE:A1 │
1100│ │ │
1101│ │ cobbler system report foo │
1102│ │ │
1103│ │ Interfaces can be deleted │
1104│ │ using the --delete-inter‐ │
1105│ │ face option. │
1106│ │ │
1107│ │ Example: │
1108│ │ │
1109│ │ cobbler system edit │
1110│ │ --name=foo --inter‐ │
1111│ │ face=eth2 --delete-inter‐ │
1112│ │ face │
1113└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1114 interface-type, inter‐ One of the other advanced
1124 face-master, bonding-opts, networking features sup‐
1125 bridge-opts ported by Cobbler is NIC
1126 bonding, bridging and BMC.
1127 You can use this to bond
1128 multiple physical network
1129 interfaces to one single
1130 logical interface to re‐
1131 duce single points of
1132 failure in your network,
1133 to create bridged inter‐
1134 faces for things like tun‐
1135 nels and virtual machine
1136 networks, or to manage BMC
1137 interface by DHCP. Sup‐
1138 ported values for the
1139 --interface-type parameter
1140 are "bond", "bond_slave",
1141 "bridge",
1142 "bridge_slave","bonded_bridge_slave"
1143 and "bmc". If one of the
1144 "_slave" options is speci‐
1145 fied, you also need to de‐
1146 fine the master-interface
1147 for this bond using --in‐
1148 terface-master=INTERFACE.
1149 Bonding and bridge options
1150 for the master-interface
1151 may be specified using
1152 --bonding-opts="foo=1
1153 bar=2" or
1154 --bridge-opts="foo=1
1155 bar=2".
1156 Example:
1158 cobbler system edit
1160 --name=foo
1161 --inter‐
1162 face=eth0
1163 --mac=AA:BB:CC:DD:EE:00
1164 --inter‐
1165 face-type=bond_slave
1166 --inter‐
1167 face-mas‐
1168 ter=bond0
1169 cobbler system edit
1171 --name=foo
1172 --inter‐
1173 face=eth1
1174 --mac=AA:BB:CC:DD:EE:01
1175 --inter‐
1176 face-type=bond_slave
1177 --inter‐
1178 face-mas‐
1179 ter=bond0
1180 cobbler system edit
1182 --name=foo
1183 --inter‐
1184 face=bond0
1185 --inter‐
1186 face-type=bond
1187 --bond‐
1188 ing-opts="mode=ac‐
1189 tive-backup
1190 miimon=100"
1191 --ip-ad‐
1192 dress=192.168.0.63
1193 --net‐
1194 mask=255.255.255.0
1195 --gate‐
1196 way=192.168.0.1
1197 --static=1
1198 More information
1200 about networking
1201 setup is available
1202 at
1203 https://github.com/cobbler/cobbler/wiki/Advanced-networking
1204 To review what net‐
1206 working configura‐
1207 tion you have for
1208 any object, run
1209 "cobbler system re‐
1210 port" at any time:
1211 Example:
1213 cobbler system re‐
1215 port --name=foo
1216├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1217│if-gateway │ If you are using static IP configurations and have multiple inter‐ │
1218│ │ faces, use this to define different gateway for each interface. │
1219│ │ │
1220│ │ This is a per-interface setting. │
1221├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1222│ip-address, ipv6-address │ If Cobbler is configured to generate a DHCP configuration (see ad‐ │
1223│ │ vanced section), use this setting to define a specific IP for this │
1224│ │ system in DHCP. Leaving off this parameter will result in no DHCP │
1225│ │ management for this particular system. │
1226│ │ │
1227│ │ Example: --ip-address=192.168.1.50 │
1228│ │ │
1229│ │ If DHCP management is disabled and the interface is labelled │
1230│ │ --static=1, this setting will be used for static IP configuration. │
1231│ │ │
1232│ │ Special feature: To control the default PXE behavior for an entire │
1233│ │ subnet, this field can also be passed in using CIDR notation. If │
1234│ │ --ip is CIDR, do not specify any other arguments other than --name │
1235│ │ and --profile. │
1236│ │ │
1237│ │ When using the CIDR notation trick, don't specify any arguments │
1238│ │ other than --name and --profile, as they won't be used. │
1239├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1240│kernel-options │ Sets kernel command-line arguments that the distro, and pro‐ │
1241│ │ files/systems depending on it, will use. To remove a kernel argu‐ │
1242│ │ ment that may be added by a higher Cobbler object (or in the │
1243│ │ global settings), you can prefix it with a !. │
1244│ │ │
1245│ │ Example: --kernel-options="foo=bar baz=3 asdf !gulp" │
1246│ │ │
1247│ │ This example passes the arguments foo=bar baz=3 asdf but will make │
1248│ │ sure gulp is not passed even if it was requested at a level higher │
1249│ │ up in the Cobbler configuration. │
1250├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1251│kernel-options-post │ This is just like --kernel-options, though it governs kernel op‐ │
1252│ │ tions on the installed OS, as opposed to kernel options fed to the │
1253│ │ installer. The syntax is exactly the same. This requires some spe‐ │
1254│ │ cial snippets to be found in your automatic installation template │
1255│ │ in order for this to work. Automatic installation templating is │
1256│ │ described later on in this document. │
1257│ │ │
1258│ │ Example: noapic │
1259├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1260│mac, mac-address │ Specifying a mac address via --mac allows the system object to │
1261│ │ boot directly to a specific profile via PXE, bypassing Cobbler's │
1262│ │ PXE menu. If the name of the Cobbler system already looks like a │
1263│ │ mac address, this is inferred from the system name and does not │
1264│ │ need to be specified. │
1265│ │ │
1266│ │ MAC addresses have the format AA:BB:CC:DD:EE:FF. It's highly rec‐ │
1267│ │ ommended to register your MAC addresses in Cobbler if you're using │
1268│ │ static addressing with multiple interfaces, or if you are using │
1269│ │ any of the advanced networking features like bonding, bridges or │
1270│ │ VLANs. │
1271│ │ │
1272│ │ Cobbler does contain a feature (enabled in /etc/cobbler/set‐ │
1273│ │ tings.yaml) that can automatically add new system records when it │
1274│ │ finds profiles being provisioned on hardware it has seen before. │
1275│ │ This may help if you do not have a report of all the MAC addresses │
1276│ │ in your datacenter/lab configuration. │
1277├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1278│mgmt-classes │ Management Classes (Management classes for external config manage‐ │
1279│ │ ment). │
1280└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1281│mgmt-parameters │ Management Parameters which will be handed to your management ap‐ │
1283│ │ plication. (Must be valid YAML dictionary) │
1284├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1285│name │ The system name works like the name option for other commands. │
1286│ │ │
1287│ │ If the name looks like a MAC address or an IP, the name will im‐ │
1288│ │ plicitly be used for either --mac or --ip of the first interface, │
1289│ │ respectively. However, it's usually better to give a descriptive │
1290│ │ name -- don't rely on this behavior. │
1291│ │ │
1292│ │ A system created with name "default" has special semantics. If a │
1293│ │ default system object exists, it sets all undefined systems to PXE │
1294│ │ to a specific profile. Without a "default" system name created, │
1295│ │ PXE will fall through to local boot for unconfigured systems. │
1296│ │ │
1297│ │ When using "default" name, don't specify any other arguments than │
1298│ │ --profile, as they won't be used. │
1299├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1300│name-servers │ If your nameservers are not provided by DHCP, you can specify a │
1301│ │ space separated list of addresses here to configure each of the │
1302│ │ installed nodes to use them (provided the automatic installation │
1303│ │ files used are installed on a per-system basis). Users with DHCP │
1304│ │ setups should not need to use this option. This is available to │
1305│ │ set in profiles to avoid having to set it repeatedly for each sys‐ │
1306│ │ tem record. │
1307├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1308│name-servers-search │ You can specify a space separated list of domain names to config‐ │
1309│ │ ure each of the installed nodes to use them as domain search path. │
1310│ │ This is available to set in profiles to avoid having to set it re‐ │
1311│ │ peatedly for each system record. │
1312├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1313│netboot-enabled │ If set false, the system will be provisionable through Koan but │
1314│ │ not through standard PXE. This will allow the system to fall back │
1315│ │ to default PXE boot behavior without deleting the Cobbler system │
1316│ │ object. The default value allows PXE. Cobbler contains a PXE boot │
1317│ │ loop prevention feature (pxe_just_once, can be enabled in │
1318│ │ /etc/cobbler/settings.yaml) that can automatically trip off this │
1319│ │ value after a system gets done installing. This can prevent in‐ │
1320│ │ stalls from appearing in an endless loop when the system is set to │
1321│ │ PXE first in the BIOS order. │
1322├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1323│next-server │ To override the Next server. │
1324├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1325│owners │ Users with small sites and a limited number of admins can probably │
1326│ │ ignore this option. All objects (distros, profiles, systems, and │
1327│ │ repos) can take a --owners parameter to specify what Cobbler users │
1328│ │ can edit particular objects.This only applies to the Cobbler WebUI │
1329│ │ and XML-RPC interface, not the "cobbler" command line tool run │
1330│ │ from the shell. Furthermore, this is only respected by the au‐ │
1331│ │ thz_ownership module which must be enabled in /etc/cobbler/mod‐ │
1332│ │ ules.conf. The value for --owners is a space separated list of │
1333│ │ users and groups as specified in /etc/cobbler/users.conf. For │
1334│ │ more information see the users.conf file as well as the Cobbler │
1335│ │ Wiki. In the default Cobbler configuration, this value is com‐ │
1336│ │ pletely ignored, as is users.conf. │
1337├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1338│power-address, power-type, │ Cobbler contains features that enable integration with power man‐ │
1339│power-user, power-pass, │ agement for easier installation, reinstallation, and management of │
1340│power-id, power-options, │ machines in a datacenter environment. These parameters are de‐ │
1341│power-identity-file │ scribed online at power-management. If you have a power-managed │
1342│ │ datacenter/lab setup, usage of these features may be something you │
1343│ │ are interested in. │
1344└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1345│profile │ The name of Cobbler profile the system will inherite its proper‐ │
1349│ │ ties. │
1350├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1351│proxy │ Proxy URL. │
1352├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1353│redhat- management-key │ Management Classes (Management classes for external config manage‐ │
1354│ │ ment). │
1355├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1356│repos-enabled │ If set true, Koan can reconfigure repositories after installation. │
1357│ │ This is described further on the Cobbler │
1358│ │ Wiki,https://github.com/cobbler/cobbler/wiki/Manage-yum-repos. │
1359├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1360│static │ Indicates that this interface is statically configured. Many │
1361│ │ fields (such as gateway/netmask) will not be used unless this │
1362│ │ field is enabled. │
1363│ │ │
1364│ │ This is a per-interface setting. │
1365├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1366│static-routes │ This is a space delimited list of ip/mask:gateway routing informa‐ │
1367│ │ tion in that format. Most systems will not need this information. │
1368│ │ │
1369│ │ This is a per-interface setting. │
1370├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1371│virt-auto-boot │ (Virt-only) Virt Auto Boot (Auto boot this VM?). │
1372├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1373│virt-bridge │ (Virt-only) This specifies the default bridge to use for all sys‐ │
1374│ │ tems defined under this profile. If not specified, it will assume │
1375│ │ the default value in the Cobbler settings file, which as shipped │
1376│ │ in the RPM is xenbr0. If using KVM, this is most likely not cor‐ │
1377│ │ rect. You may want to override this setting in the system object. │
1378│ │ Bridge settings are important as they define how outside network‐ │
1379│ │ ing will reach the guest. For more information on bridge setup, │
1380│ │ see the Cobbler Wiki, where there is a section describing Koan us‐ │
1381│ │ age. │
1382├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1383│virt-cpus │ (Virt-only) How many virtual CPUs should Koan give the virtual ma‐ │
1384│ │ chine? The default is 1. This is an integer. │
1385├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1386│virt-disk-driver │ (Virt-only) Virt Disk Driver Type (The on-disk format for the vir‐ │
1387│ │ tualization disk). Valid options are <<inherit>>, raw, qcow2, │
1388│ │ qed, vdi, vmdk │
1389├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1390│virt-file-size │ (Virt-only) How large the disk image should be in Gigabytes. The │
1391│ │ default is 5. This can be a comma separated list (ex: 5,6,7) to │
1392│ │ allow for multiple disks of different sizes depending on what is │
1393│ │ given to --virt-path. This should be input as a integer or decimal │
1394│ │ value without units. │
1395├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1396│virt-path │ (Virt-only) Where to store the virtual image on the host system. │
1397│ │ Except for advanced cases, this parameter can usually be omitted. │
1398│ │ For disk images, the value is usually an absolute path to an ex‐ │
1399│ │ isting directory with an optional filename component. There is │
1400│ │ support for specifying partitions /dev/sda4 or volume groups Vol‐ │
1401│ │ Group00, etc. │
1402│ │ │
1403│ │ For multiple disks, separate the values with commas such as Vol‐ │
1404│ │ Group00,VolGroup00 or /dev/sda4,/dev/sda5. Both those examples │
1405│ │ would create two disks for the VM. │
1406├───────────────────────────┼────────────────────────────────────────────────────────────────────┤
1407│virt-ram │ (Virt-only) How many megabytes of RAM to consume. The default is │
1408│ │ 512 MB. This should be input as an integer without units. │
1409└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1410│virt-type │ (Virt-only) Koan can install images using either Xen paravirt │
1415│ │ (xenpv) or QEMU/KVM (qemu). Choose one or the other strings to │
1416│ │ specify, or values will default to attempting to find a compatible │
1417│ │ installation type on the client system("auto"). See the "Koan" │
1418│ │ manpage for more documentation. The default --virt-type can be │
1419│ │ configured in the Cobbler settings file such that this parameter │
1420│ │ does not have to be provided. Other virtualization types are sup‐ │
1421│ │ ported, for information on those options (such as VMware), see the │
1422│ │ Cobbler Wiki. │
1423└───────────────────────────┴────────────────────────────────────────────────────────────────────┘
1424 Cobbler repo
1426 Repository mirroring allows Cobbler to mirror not only install trees
1427 ("cobbler import" does this for you) but also optional packages, 3rd
1428 party content, and even updates. Mirroring all of this content locally
1429 on your network will result in faster, more up-to-date installations
1430 and faster updates. If you are only provisioning a home setup, this
1431 will probably be overkill, though it can be very useful for larger set‐
1432 ups (labs, datacenters, etc).
1433 $ cobbler repo add --mirror=url --name=string [--rpmlist=list] [--creatrepo-flags=string] [--keep-updated=Y/N] [--priority=number] [--arch=string] [--mirror-locally=Y/N] [--breed=yum|rsync|rhn] [--mirror_type=baseurl|mirrorlist|metalink]
1435┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────┬──────────────────────────────┐
1437│Name │ Description │
1438├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1439│apt-components │ Apt Components (apt only) │
1440│ │ (ex: main restricted uni‐ │
1441│ │ verse) │
1442├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1443│apt-dists │ Apt Dist Names (apt only) │
1444│ │ (ex: precise precise-up‐ │
1445│ │ dates) │
1446├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1447│arch │ Specifies what architec‐ │
1448│ │ ture the repository should │
1449│ │ use. By default the cur‐ │
1450│ │ rent system arch (of the │
1451│ │ server) is used,which may │
1452│ │ not be desirable. Using │
1453│ │ this to override the de‐ │
1454│ │ fault arch allows mirror‐ │
1455│ │ ing of source reposito‐ │
1456│ │ ries(using --arch=src). │
1457├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1458│breed │ Ordinarily Cobbler's repo │
1459│ │ system will understand │
1460│ │ what you mean without sup‐ │
1461│ │ plying this parameter, │
1462│ │ though you can set it ex‐ │
1463│ │ plicitly if needed. │
1464├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1465│comment │ Simple attach a descrip‐ │
1466│ │ tion (Free form text) to │
1467│ │ your distro. │
1468├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1469│createrepo-flags │ Specifies optional flags │
1470│ │ to feed into the cre‐ │
1471│ │ aterepo tool, which is │
1472│ │ called when cobbler re‐ │
1473│ │ posync is run for the │
1474│ │ given repository. The de‐ │
1475│ │ faults are -c cache. │
1476└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────────────────┘
1477│keep-updated │ Specifies that the named │
1481│ │ repository should not be │
1482│ │ updated during a normal │
1483│ │ "cobbler reposync". The │
1484│ │ repo may still be updated │
1485│ │ by name. The repo should │
1486│ │ be synced at least once │
1487│ │ before disabling this fea‐ │
1488│ │ ture. See "cobbler re‐ │
1489│ │ posync" below. │
1490└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────────────────┘
1491│mirror │ The address of the yum │
1547│ │ mirror. This can be an │
1548│ │ rsync://-URL, an ssh loca‐ │
1549│ │ tion, or a http:// or │
1550│ │ ftp:// mirror location. │
1551│ │ Filesystem paths also │
1552│ │ work. │
1553│ │ │
1554│ │ The mirror address should │
1555│ │ specify an exact reposi‐ │
1556│ │ tory to mirror -- just one │
1557│ │ architecture and just one │
1558│ │ distribution. If you have │
1559│ │ a separate repo to mirror │
1560│ │ for a different arch, add │
1561│ │ that repo separately. │
1562│ │ │
1563│ │ Here's an example of what │
1564│ │ looks like a good URL: │
1565│ │ │
1566│ │ • rsync://yourmir‐ │
1567│ │ ror.exam‐ │
1568│ │ ple.com/fe‐ │
1569│ │ dora-linux-core/up‐ │
1570│ │ dates/6/i386 (for │
1571│ │ rsync protocol) │
1572│ │ │
1573│ │ • http://mir‐ │
1574│ │ rors.ker‐ │
1575│ │ nel.org/fe‐ │
1576│ │ dora/ex‐ │
1577│ │ tras/6/i386/ (for │
1578│ │ http) │
1579│ │ │
1580│ │ • user@yourmir‐ │
1581│ │ ror.exam‐ │
1582│ │ ple.com/fe‐ │
1583│ │ dora-linux-core/up‐ │
1584│ │ dates/6/i386 │
1585│ │ (for SSH) │
1586│ │ │
1587│ │ Experimental sup‐ │
1588│ │ port is also pro‐ │
1589│ │ vided for mirroring │
1590│ │ RHN content when │
1591│ │ you need a fast lo‐ │
1592│ │ cal mirror. The │
1593│ │ mirror syntax for │
1594│ │ this is --mir‐ │
1595│ │ ror=rhn://chan‐ │
1596│ │ nel-name and you │
1597│ │ must have entitle‐ │
1598│ │ ments for this to │
1599│ │ work. This requires │
1600│ │ the Cobbler server │
1601│ │ to be installed on │
1602│ │ RHEL 5 or later. │
1603│ │ You will also need │
1604│ │ a version of │
1605│ │ yum-utils equal or │
1606│ │ greater to 1.0.4. │
1607└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────────────────┘
1608│mirror-locally │ When set to N, specifies │
1613│ │ that this yum repo is to be │
1614│ │ referenced directly via au‐ │
1615│ │ tomatic installation files │
1616│ │ and not mirrored locally on │
1617│ │ the Cobbler server. Only │
1618│ │ http:// and ftp:// mirror │
1619│ │ urls are supported when us‐ │
1620│ │ ing --mirror-locally=N, you │
1621│ │ cannot use filesystem URLs. │
1622├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1623│name │ This name is used as the │
1624│ │ save location for the mir‐ │
1625│ │ ror. If the mirror repre‐ │
1626│ │ sented, say, Fedora Core 6 │
1627│ │ i386 updates, a good name │
1628│ │ would be fc6i386updates. │
1629│ │ Again, be specific. │
1630│ │ │
1631│ │ This name corresponds with │
1632│ │ values given to the --repos │
1633│ │ parameter of cobbler profile │
1634│ │ add. If a profile has a │
1635│ │ --repos-value that matches │
1636│ │ the name given here, that │
1637│ │ repo can be automatically │
1638│ │ set up during provisioning │
1639│ │ (when supported) and in‐ │
1640│ │ stalled systems will also │
1641│ │ use the boot server as a │
1642│ │ mirror (unless yum_post_in‐ │
1643│ │ stall_mirror is disabled in │
1644│ │ the settings file). By de‐ │
1645│ │ fault the provisioning │
1646│ │ server will act as a mirror │
1647│ │ to systems it installs, │
1648│ │ which may not be desirable │
1649│ │ for laptop configurations, │
1650│ │ etc. │
1651│ │ │
1652│ │ Distros that can make use of │
1653│ │ yum repositories during au‐ │
1654│ │ tomatic installation include │
1655│ │ FC6 and later, RHEL 5 and │
1656│ │ later, and derivative dis‐ │
1657│ │ tributions. │
1658│ │ │
1659│ │ See the documentation on │
1660│ │ cobbler profile add for more │
1661│ │ information. │
1662└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────────────────┘
1663│ │ │
1679│ owners | Users with │ │
1680│ small sites and a │ │
1681│ limited number of │ │
1682│ admins can probably │ │
1683│ ignore this option. │ │
1684│ All │ │
1685│ objects (distros, profiles, systems, and repos) can take a --owners parameter to specify what │ │
1686│ Cobbler users can edit particular objects.This only applies to the Cobbler WebUI and XML-RPC │ │
1687│ interface, not the "cobbler" command line tool run from the shell. Furthermore, this is only │ │
1688│ respected by the authz_ownership module which must be enabled in │ │
1689│ /etc/cobbler/modules.conf. The value for --owners is a space separated list of users │ │
1690│ and groups as specified in /etc/cobbler/users.conf. │ │
1691│ For more information see the users.conf file as well as the Cobbler │ │
1692│ Wiki. In the default Cobbler configuration, this value is completely ignored, as is │ │
1693│ users.conf. │ │
1694│ │ │
1695├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1696│ │ │
1697│ priority | Specifies the priority of the repository (the lower the number, the higher the priority), │ │
1698│ which │ │
1699│ applies to installed machines using the repositories that also have the yum priorities plugin │ │
1700│ installed. The default priority for the plugins 99, as is that of all Cobbler mirrored │ │
1701│ repositories. │ │
1702│ │ │
1703├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1704│proxy | Proxy URL. │ │
1705├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1706│ │ │
1707│ rpm-list | By specifying a space-delimited list of package names for --rpm-list, one can decide to │ │
1708│ mirror │ │
1709│ only a part of a repo (the list of packages given, plus dependencies). This may be helpful in │ │
1710│ conserving time/space/bandwidth. For instance, when mirroring FC6 Extras, it may be desired to │ │
1711│ mirror just Cobbler and Koan, and skip all of the game packages. To do this, use │ │
1712│ --rpm-list="cobbler koan". │ │
1713│ │ │
1714│ This option only works for http:// and ftp:// repositories (as it is powered by │ │
1715│ yumdownloader). It will be ignored for other mirror types, such as local paths and rsync:// │ │
1716│ mirrors. │ │
1717│ │ │
1718├─────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────────────────┤
1719│yumopts │ Sets values for additional │
1720│ │ yum options that the repo │
1721│ │ should use on installed sys‐ │
1722│ │ tems. For instance if a yum │
1723│ │ plugin takes a certain pa‐ │
1724│ │ rameter "alpha" and "beta", │
1725│ │ use something like --yu‐ │
1726│ │ mopts="alpha=2 beta=3". │
1727└─────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────────────────┘
1728 $ cobbler repo autoadd
1730 Add enabled yum repositories from dnf repolist --enabled list. The
1732 repository names are generated using the <repo id>-<releasever>-<arch>
1733 pattern (ex: fedora-32-x86_64). Existing repositories with such names
1734 are not overwritten.
1735 Cobbler image
1737 Example:
1738 $ cobbler image
1740 Cobbler mgmtclass
1742 Management classes allows Cobbler to function as an configuration man‐
1743 agement system. Cobbler currently supports the following resource
1744 types:
1745 1. Packages
1747 2. Files
1749 Resources are executed in the order listed above.
1751 $ cobbler mgmtclass add --name=string --comment=string [--packages=list] [--files=list]
1753 ┌───────────┬────────────────────────────┐
1755 │Name │ Description │
1756 ├───────────┼────────────────────────────┤
1757 │class-name │ Class Name (Actual Class │
1758 │ │ Name (leave blank to use │
1759 │ │ the name field)). │
1760 ├───────────┼────────────────────────────┤
1761 │comment │ A comment that describes │
1762 │ │ the functions of the man‐ │
1763 │ │ agement class. │
1764 ├───────────┼────────────────────────────┤
1765 │files │ Specifies a list of file │
1766 │ │ resources required by the │
1767 │ │ management class. │
1768 ├───────────┼────────────────────────────┤
1769 │name │ The name of the mgmtclass. │
1770 │ │ Use this name when adding │
1771 │ │ a management class to a │
1772 │ │ system, profile, or dis‐ │
1773 │ │ tro. To add a mgmtclass │
1774 │ │ to an existing system use │
1775 │ │ something like (cobbler │
1776 │ │ system edit --name="mad‐ │
1777 │ │ hatter" │
1778 │ │ --mgmt-classes="http │
1779 │ │ mysql"). │
1780 ├───────────┼────────────────────────────┤
1781 │packages │ Specifies a list of pack‐ │
1782 │ │ age resources required by │
1783 │ │ the management class. │
1784 └───────────┴────────────────────────────┘
1785 Cobbler package
1787 Package resources are managed using cobbler package add
1788 Actions:
1790 ┌──────────┬────────────────────────────┐
1792 │Name │ Description │
1793 ├──────────┼────────────────────────────┤
1794 │install │ Install the package. [De‐ │
1795 │ │ fault] │
1796 ├──────────┼────────────────────────────┤
1797 │uninstall │ Uninstall the package. │
1798 └──────────┴────────────────────────────┘
1799 Attributes:
1801 ┌──────────┬────────────────────────────┐
1803 │Name │ Description │
1804 ├──────────┼────────────────────────────┤
1805 │installer │ Which package manager to │
1806 │ │ use, valid options │
1807 │ │ [rpm|yum]. │
1808 └──────────┴────────────────────────────┘
1809 │name │ Cobbler object name. │
1811 ├──────────┼────────────────────────────┤
1812 │version │ Which version of the pack‐ │
1813 │ │ age to install. │
1814 └──────────┴────────────────────────────┘
1815 Example:
1817 $ cobbler package add --name=string --comment=string [--action=install|uninstall] --installer=string [--version=string]
1819 Cobbler file
1821 Actions:
1822 ┌───────┬────────────────────────────┐
1824 │Name │ Description │
1825 ├───────┼────────────────────────────┤
1826 │create │ Create the file. [Default] │
1827 ├───────┼────────────────────────────┤
1828 │remove │ Remove the file. │
1829 └───────┴────────────────────────────┘
1830 Attributes:
1832 ┌─────────┬────────────────────────────┐
1834 │Name │ Description │
1835 ├─────────┼────────────────────────────┤
1836 │group │ The group owner of the │
1837 │ │ file. │
1838 ├─────────┼────────────────────────────┤
1839 │mode │ Permission mode (as in │
1840 │ │ chmod). │
1841 ├─────────┼────────────────────────────┤
1842 │name │ Name of the cobbler file │
1843 │ │ object │
1844 ├─────────┼────────────────────────────┤
1845 │path │ The path for the file. │
1846 ├─────────┼────────────────────────────┤
1847 │template │ The template for the file. │
1848 ├─────────┼────────────────────────────┤
1849 │user │ The user for the file. │
1850 └─────────┴────────────────────────────┘
1851 Example:
1853 $ cobbler file add --name=string --comment=string [--action=string] --mode=string --group=string --owner=string --path=string [--template=string]
1855 Cobbler menu
1857 By default, Cobbler builds a single-level boot menu for profiles and
1858 images. To simplify navigation through a large number of OS boot items,
1859 you can create menu objects and place any number of submenus, profiles,
1860 and images there. The menu is hierarchical, to indicate the nesting of
1861 one submenu in another, you can use the parent property. If the parent
1862 property for a submenu, or the menu property for a profile or images
1863 are not set or have an empty value, then the corresponding element will
1864 be displayed in the top-level menu. If a submenu does not have descen‐
1865 dants in the form of profiles or images, then such a submenu will not
1866 be displayed in the boot menu.
1867 $ cobbler menu add --name=string [--display-name=string] [--parent=string]
1869 ┌─────────────┬────────────────────────────┐
1871 │Name │ Description │
1872 └─────────────┴────────────────────────────┘
1873 │display-name │ This is a human-readable │
1877 │ │ name to display in the │
1878 │ │ boot menu. │
1879 ├─────────────┼────────────────────────────┤
1880 │name │ This name can be used as a │
1881 │ │ --parent for a submenu, or │
1882 │ │ as a --menu for a profile │
1883 │ │ or image. │
1884 ├─────────────┼────────────────────────────┤
1885 │parent │ This value can be set to │
1886 │ │ indicate the nesting of │
1887 │ │ this submenu in another. │
1888 └─────────────┴────────────────────────────┘
1889 Cobbler aclsetup
1891 Example:
1892 $ cobbler aclsetup
1894 Cobbler buildiso
1896 This command may not behave like you expect it without installing addi‐
1897 tional dependencies and configuration. The in depth explanation can be
1898 found at Building ISOs.
1899 ┌─────────────┬────────────────────────────┐
1901 │Name │ Description │
1902 ├─────────────┼────────────────────────────┤
1903 │iso │ Output ISO to this file. │
1904 │ │ If the file exists it will │
1905 │ │ be truncated to zero be‐ │
1906 │ │ fore. │
1907 ├─────────────┼────────────────────────────┤
1908 │profiles │ Use these profiles only │
1909 │ │ for information collec‐ │
1910 │ │ tion. │
1911 ├─────────────┼────────────────────────────┤
1912 │systems │ (net-only) Use these sys‐ │
1913 │ │ tems only for information │
1914 │ │ collection. │
1915 ├─────────────┼────────────────────────────┤
1916 │tempdir │ Working directory for │
1917 │ │ building the ISO. The de‐ │
1918 │ │ fault value is set in the │
1919 │ │ settings file. │
1920 ├─────────────┼────────────────────────────┤
1921 │distro │ Used to detect the archi‐ │
1922 │ │ tecture of the ISO you are │
1923 │ │ building. Specifies also │
1924 │ │ the used Kernel and Ini‐ │
1925 │ │ trd. │
1926 ├─────────────┼────────────────────────────┤
1927 │standalone │ (offline-only) Creates a │
1928 │ │ standalone ISO with all │
1929 │ │ required distribution │
1930 │ │ files but without any │
1931 │ │ added repositories. │
1932 ├─────────────┼────────────────────────────┤
1933 │airgapped │ (offline-only) Implies │
1934 │ │ --standalone but addition‐ │
1935 │ │ ally includes repo files │
1936 │ │ for disconnected system │
1937 │ │ installations. │
1938 └─────────────┴────────────────────────────┘
1939 │source │ (offline-only) Used with │
1943 │ │ --standalone or --air‐ │
1944 │ │ gapped to specify a source │
1945 │ │ for the distribution │
1946 │ │ files. │
1947 ├─────────────┼────────────────────────────┤
1948 │exclude-dns │ (net-only) Prevents addi‐ │
1949 │ │ tion of name server ad‐ │
1950 │ │ dresses to the kernel boot │
1951 │ │ options. │
1952 ├─────────────┼────────────────────────────┤
1953 │xorriso-opts │ Extra options for xorriso. │
1954 └─────────────┴────────────────────────────┘
1955 Example: The following command builds a single ISO file for all pro‐
1957 files and systems present under the distro test.
1958 $ cobbler buildiso --distro=test
1960 Cobbler import
1962 NOTE:
1963 When running Cobbler via systemd, you cannot mount the ISO to /tmp
1964 or a sub-folder of it because we are using the option Private Tempo‐
1965 rary Directory, to enhance the security of our application.
1966 Example:
1968 $ cobbler import
1970 Cobbler list
1972 This list all the names grouped by type. Identically to cobbler report
1973 there are subcommands for most of the other Cobbler commands. (Cur‐
1974 rently: distro, profile, system, repo, image, mgmtclass, package, file)
1975 $ cobbler list
1977 Cobbler replicate
1979 Cobbler can replicate configurations from a master Cobbler server. Each
1980 Cobbler server is still expected to have a locally relevant /etc/cob‐
1981 bler/cobbler.conf and modules.conf, as these files are not synced.
1982 This feature is intended for load-balancing, disaster-recovery, backup,
1984 or multiple geography support.
1985 Cobbler can replicate data from a central server.
1987 Objects that need to be replicated should be specified with a pattern,
1989 such as --profiles="webservers* dbservers*" or --systems="*.exam‐
1990 ple.org". All objects matched by the pattern, and all dependencies of
1991 those objects matched by the pattern (recursively) will be transferred
1992 from the remote server to the central server. This is to say if you in‐
1993 tend to transfer *.example.org and the definition of the systems have
1994 not changed, but a profile above them has changed, the changes to that
1995 profile will also be transferred.
1996 In the case where objects are more recent on the local server, those
1998 changes will not be overridden locally.
1999 Common data locations will be rsync'ed from the master server unless
2001 --omit-data is specified.
2002 To delete objects that are no longer present on the master server, use
2004 --prune.
2005 Warning: This will delete all object types not present on the remote
2007 server from the local server, and is recursive. If you use prune, it
2008 is best to manage Cobbler centrally and not expect changes made on the
2009 slave servers to be preserved. It is not currently possible to just
2010 prune objects of a specific type.
2011 Example:
2013 $ cobbler replicate --master=cobbler.example.org [--distros=pattern] [--profiles=pattern] [--systems=pattern] [--repos-pattern] [--images=pattern] [--prune] [--omit-data]
2015 Cobbler report
2017 This lists all configuration which Cobbler can obtain from the saved
2018 data. There are also report subcommands for most of the other Cobbler
2019 commands (currently: distro, profile, system, repo, image, mgmtclass,
2020 package, file, menu).
2021 $ cobbler report --name=[object-name]
2023 --name=[object-name]
2025 Optional parameter which filters for object with the given name.
2027 Cobbler reposync
2029 Example:
2030 $ cobbler reposync [--only=ONLY] [--tries=TRIES] [--no-fail]
2032 Cobbler reposync is the command to use to update repos as configured
2034 with cobbler repo add. Mirroring can take a long time, and usage of
2035 cobbler reposync prior to usage is needed to ensure provisioned systems
2036 have the files they need to actually use the mirrored repositories. If
2037 you just add repos and never run cobbler reposync, the repos will never
2038 be mirrored. This is probably a command you would want to put on a
2039 crontab, though the frequency of that crontab and where the output goes
2040 is left up to the systems administrator.
2041 For those familiar with dnf’s reposync, cobbler’s reposync is (in most
2043 uses) a wrapper around the dnf reposync command. Please use cobbler re‐
2044 posync to update cobbler mirrors, as dnf’s reposync does not perform
2045 all required steps. Also cobbler adds support for rsync and SSH loca‐
2046 tions, where as dnf’s reposync only supports what dnf supports
2047 (http/ftp).
2048 If you ever want to update a certain repository you can run: cobbler
2050 reposync --only="reponame1" ...
2051 When updating repos by name, a repo will be updated even if it is set
2053 to be not updated during a regular reposync operation (ex: cobbler repo
2054 edit –name=reponame1 –keep-updated=0). Note that if a cobbler import
2055 provides enough information to use the boot server as a yum mirror for
2056 core packages, cobbler can set up automatic installation files to use
2057 the cobbler server as a mirror instead of the outside world. If this
2058 feature is desirable, it can be turned on by setting yum_post_in‐
2059 stall_mirror to True in /etc/cobbler/settings.yaml (and running cobbler
2060 sync). You should not use this feature if machines are provisioned on a
2061 different VLAN/network than production, or if you are provisioning lap‐
2062 tops that will want to acquire updates on multiple networks.
2063 The flags --tries=N (for example, --tries=3) and --no-fail should
2065 likely be used when putting re-posync on a crontab. They ensure network
2066 glitches in one repo can be retried and also that a failure to synchro‐
2067 nize one repo does not stop other repositories from being synchronized.
2068 Cobbler sync
2070 The sync command is very important, though very often unnecessary for
2071 most situations. It's primary purpose is to force a rewrite of all con‐
2072 figuration files, distribution files in the TFTP root, and to restart
2073 managed services. So why is it unnecessary? Because in most common sit‐
2074 uations (after an object is edited, for example), Cobbler executes what
2075 is known as a "lite sync" which rewrites most critical files.
2076 When is a full sync required? When you are using manage_dhcpd (Managing
2078 DHCP) with systems that use static leases. In that case, a full sync
2079 is required to rewrite the dhcpd.conf file and to restart the dhcpd
2080 service.
2081 Cobbler sync is used to repair or rebuild the contents /tftpboot or
2083 /var/www/cobbler when something has changed behind the scenes. It
2084 brings the filesystem up to date with the configuration as understood
2085 by Cobbler.
2086 Sync should be run whenever files in /var/lib/cobbler are manually
2088 edited (which is not recommended except for the settings file) or when
2089 making changes to automatic installation files. In practice, this
2090 should not happen often, though running sync too many times does not
2091 cause any adverse effects.
2092 If using Cobbler to manage a DHCP and/or DNS server (see the advanced
2094 section of this manpage), sync does need to be run after systems are
2095 added to regenerate and reload the DHCP/DNS configurations. If you want
2096 to trigger the DHCP/DNS regeneration only and do not want a complete
2097 sync, you can use cobbler sync --dhcp or cobbler sync --dns or the com‐
2098 bination of both.
2099 cobbler sync --systems is used to only write specific systems (must ex‐
2101 ists in backend storage) to the TFTP folder. The expected pattern is a
2102 comma separated list of systems e.g. sys1.internal,sys2.inter‐
2103 nal,sys3.internal.
2104 NOTE:
2106 Please note that at least once a full sync has to be run beforehand.
2107 The sync process can also be kicked off from the web interface.
2109 Example:
2111 $ cobbler sync
2113 $ cobbler sync [--systems=sys1.internal,sys2.internal,sys3.internal]
2114 $ cobbler sync [--dns]
2115 $ cobbler sync [--dhcp]
2116 $ cobbler sync [--dns --dhcp]
2117 Cobbler validate-autoinstalls
2119 Example:
2120 $ cobbler validate-autoinstalls
2122 Cobbler version
2124 Example:
2125 $ cobbler version
2127 Cobbler signature
2129 Example:
2130 $ cobbler signature
2132 Cobbler hardlink
2134 Example:
2135 $ cobbler hardlink
2137 Cobbler mkloaders
2139 This command is used for generating UEFI bootable GRUB 2 bootloaders.
2140 This command has no options and is configured via the settings file of
2141 Cobbler. If available on the operating system Cobbler is running on,
2142 then this also generates bootloaders for different architectures then
2143 the one of the system.
2144 NOTE:
2146 This command should be executed every time the bootloader modules
2147 are being updated, running it more frequently does not help, running
2148 it less frequently will cause the bootloader to be possibly vulnera‐
2149 ble.
2150 Example:
2152 $ cobbler mkloaders
2154
2156 Cobbler's command line returns a zero for success and non-zero for
2157 failure.
2158
2160 We have a Gitter Channel and you also can ask questions as GitHub is‐
2161 sues. The IRC Channel on Freenode (#cobbler) is not that active but
2162 sometimes there are people who can help you.
2163 The way we would prefer are GitHub issues as they are easily search‐
2165 able.
2166
2168 Jörgen Maas
2169
2171 2023, Enno Gotthold
21723.3 Jul 19, 2023 COBBLER(1)