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
12 This should just be a brief overview. For the detailed explanations
13 please refer to Readthedocs.
14 Distros, Profiles and Systems
16 Cobbler has a system of inheritance when it comes to managing the in‐
17 formation you want to apply to a certain system.
18 Images
20 Repositories
21 Management Classes
22 Deleting configuration entries
23 If you want to remove a specific object, use the remove command with
24 the name that was used to add it.
25 cobbler distro|profile|system|repo|image|mgmtclass|package|file remove --name=string
27 Editing
29 If you want to change a particular setting without doing an add again,
30 use the edit command, using the same name you gave when you added the
31 item. Anything supplied in the parameter list will overwrite the set‐
32 tings in the existing object, preserving settings not mentioned.
33 cobbler distro|profile|system|repo|image|mgmtclass|package|file edit --name=string [parameterlist]
35 Copying
37 Objects can also be copied:
38 cobbler distro|profile|system|repo|image|mgmtclass|package|file copy --name=oldname --newname=newname
40 Renaming
42 Objects can also be renamed, as long as other objects don't reference
43 them.
44 cobbler distro|profile|system|repo|image|mgmtclass|package|file rename --name=oldname --newname=newname
46
48 Short Usage: cobbler command [subcommand] [--arg1=value1]
49 [--arg2=value2]
50 Long Usage:
52 cobbler <distro|profile|system|repo|image|mgmtclass|package|file> ... [add|edit|copy|get-autoinstall*|list|remove|rename|report] [options|--help]
54 cobbler <aclsetup|buildiso|import|list|replicate|report|reposync|sync|validate-autoinstalls|version|signature|get-loaders|hardlink> [options|--help]
55 Cobbler distro
57 This first step towards configuring what you want to install is to add
58 a distribution record to Cobbler's configuration.
59 If there is an rsync mirror, DVD, NFS, or filesystem tree available
61 that you would rather import instead, skip down to the documentation
62 about the import command. It's really a lot easier to follow the import
63 workflow -- it only requires waiting for the mirror content to be
64 copied and/or scanned. Imported mirrors also save time during install
65 since they don't have to hit external install sources.
66 If you want to be explicit with distribution definition, however,
68 here's how it works:
69 $ cobbler distro add --name=string --kernel=path --initrd=path [--kopts=string] [--kopts-post=string] [--ksmeta=string] [--arch=i386|x86_64|ppc|ppc64] [--breed=redhat|debian|suse] [--template-files=string]
71 ┌────────────────────┬────────────────────────────┐
73 │Name │ Description │
74 ├────────────────────┼────────────────────────────┤
75 │name │ a string identifying the │
76 │ │ distribution, this should │
77 │ │ be something like rhel6. │
78 ├────────────────────┼────────────────────────────┤
79 │kernel │ An absolute filesystem │
80 │ │ path to a kernel image. │
81 ├────────────────────┼────────────────────────────┤
82 │initrd │ An absolute filesystem │
83 │ │ path to a initrd image. │
84 ├────────────────────┼────────────────────────────┤
85 │remote-boot- kernel │ A URL pointing to the in‐ │
86 │ │ stallation initrd of a │
87 │ │ distribution. If the boot‐ │
88 │ │ loader has this support, │
89 │ │ it will directly download │
90 │ │ the kernel from this URL, │
91 │ │ instead of the directory │
92 │ │ of the TFTP client. Note: │
93 │ │ The kernel (or initrd be‐ │
94 │ │ low) will still be copied │
95 │ │ into the image directory │
96 │ │ of the TFTP server. The │
97 │ │ above kernel parameter is │
98 │ │ still needed (e.g. to │
99 │ │ build iso images, etc.). │
100 │ │ The advantage of letting │
101 │ │ the boot loader retrieve │
102 │ │ the kernel/initrd directly │
103 │ │ is the support of chang‐ │
104 │ │ ing/updated distributions. │
105 │ │ E.g. openSUSE Tumbleweed │
106 │ │ is updated on the fly and │
107 │ │ if Cobbler would │
108 │ │ copy/cache the kernel/ini‐ │
109 │ │ trd in the TFTP directory, │
110 │ │ you would get a "kernel │
111 │ │ does not match distribu‐ │
112 │ │ tion" (or similar) error │
113 │ │ when trying to install. │
114 ├────────────────────┼────────────────────────────┤
115 │remote-boot- initrd │ See remote-boot-kernel │
116 │ │ above. │
117 ├────────────────────┼────────────────────────────┤
118 │kopts │ Sets kernel command-line │
119 │ │ arguments that the distro, │
120 │ │ and profiles/systems de‐ │
121 │ │ pending on it, will use. │
122 │ │ To remove a kernel argu‐ │
123 │ │ ment that may be added by │
124 │ │ a higher Cobbler object │
125 │ │ (or in the global set‐ │
126 │ │ tings), you can prefix it │
127 │ │ with a !. │
128 ├────────────────────┼────────────────────────────┤
129 │ │ Example: --kopts="foo=bar │
130 │ │ baz=3 asdf !gulp" │
131 └────────────────────┴────────────────────────────┘
132 │ │ This example passes the │
134 │ │ arguments foo=bar baz=3 │
135 │ │ asdf but will make sure │
136 │ │ gulp is not passed even if │
137 │ │ it was requested at a │
138 │ │ level higher up in the │
139 │ │ Cobbler configuration. │
140 ├────────────────────┼────────────────────────────┤
141 │kopts-post │ This is just like --kopts, │
142 │ │ though it governs kernel │
143 │ │ options on the installed │
144 │ │ OS, as opposed to kernel │
145 │ │ options fed to the in‐ │
146 │ │ staller. The syntax is ex‐ │
147 │ │ actly the same. This re‐ │
148 │ │ quires some special snip‐ │
149 │ │ pets to be found in your │
150 │ │ automatic installation │
151 │ │ template in order for this │
152 │ │ to work. Automatic instal‐ │
153 │ │ lation templating is de‐ │
154 │ │ scribed later on in this │
155 │ │ document. │
156 ├────────────────────┼────────────────────────────┤
157 │ │ Example: noapic │
158 ├────────────────────┼────────────────────────────┤
159 │arch │ Sets the architecture for │
160 │ │ the PXE bootloader and │
161 │ │ also controls how Koan's │
162 │ │ --replace-self option will │
163 │ │ operate. │
164 ├────────────────────┼────────────────────────────┤
165 │ │ The default setting (stan‐ │
166 │ │ dard) will use pxelinux. │
167 │ │ Set to ppc and ppc64 to │
168 │ │ use yaboot. │
169 ├────────────────────┼────────────────────────────┤
170 │ │ x86 and x86_64 effectively │
171 │ │ do the same thing as stan‐ │
172 │ │ dard. │
173 ├────────────────────┼────────────────────────────┤
174 │ │ If you perform a cobbler │
175 │ │ import, the arch field │
176 │ │ will be auto-assigned. │
177 ├────────────────────┼────────────────────────────┤
178 │ksmeta │ This is an advanced fea‐ │
179 │ │ ture that sets automatic │
180 │ │ installation template │
181 │ │ variables to substitute, │
182 │ │ thus enabling those files │
183 │ │ to be treated as tem‐ │
184 │ │ plates. Templates are pow‐ │
185 │ │ ered using Cheetah and are │
186 │ │ described further along in │
187 │ │ this manpage as well as on │
188 │ │ the Cobbler Wiki. │
189 ├────────────────────┼────────────────────────────┤
190 │ │ Example: --ksmeta="foo=bar │
191 │ │ baz=3 asdf" │
192 ├────────────────────┼────────────────────────────┤
193 │ │ See the section on "Kick‐ │
194 │ │ start Templating" for fur‐ │
195 │ │ ther information. │
196 └────────────────────┴────────────────────────────┘
197 │breed │ Controls how various phys‐ │
200 │ │ ical and virtual parame‐ │
201 │ │ ters, including kernel ar‐ │
202 │ │ guments for automatic in‐ │
203 │ │ stallation, are to be │
204 │ │ treated. Defaults to red‐ │
205 │ │ hat, which is a suitable │
206 │ │ value for Fedora and Cen‐ │
207 │ │ tOS as well. It means any‐ │
208 │ │ thing Red Hat based. │
209 ├────────────────────┼────────────────────────────┤
210 │ │ There is limited experi‐ │
211 │ │ mental support for speci‐ │
212 │ │ fying "debian", "ubuntu", │
213 │ │ or "suse", which treats │
214 │ │ the automatic installation │
215 │ │ template file as a pre‐ │
216 │ │ seed/autoyast file format │
217 │ │ and changes the kernel ar‐ │
218 │ │ guments appropriately. │
219 │ │ Support for other types of │
220 │ │ distributions is possible │
221 │ │ in the future. See the │
222 │ │ Wiki for the latest infor‐ │
223 │ │ mation about support for │
224 │ │ these distributions. │
225 ├────────────────────┼────────────────────────────┤
226 │ │ The file used for the an‐ │
227 │ │ swer file, regardless of │
228 │ │ the breed setting, is the │
229 │ │ value used for --autoinst │
230 │ │ when creating the profile. │
231 ├────────────────────┼────────────────────────────┤
232 │os-version │ Generally this field can │
233 │ │ be ignored. It is intended │
234 │ │ to alter some hardware │
235 │ │ setup for virtualized in‐ │
236 │ │ stances when provisioning │
237 │ │ guests with Koan. The │
238 │ │ valid options for │
239 │ │ --os-version vary depend‐ │
240 │ │ ing on what is specified │
241 │ │ for --breed. If you spec‐ │
242 │ │ ify an invalid option, the │
243 │ │ error message will contain │
244 │ │ a list of valid OS ver‐ │
245 │ │ sions that can be used. If │
246 │ │ you don't know the OS ver‐ │
247 │ │ sion or it does not appear │
248 │ │ in the list, omitting this │
249 │ │ argument or using other │
250 │ │ should be perfectly fine. │
251 │ │ If you don't encounter any │
252 │ │ problems with virtualized │
253 │ │ instances, this option can │
254 │ │ be safely ignored. │
255 └────────────────────┴────────────────────────────┘
256 │owners │ Users with small sites and │
266 │ │ a limited number of admins │
267 │ │ can probably ignore this │
268 │ │ option. All Cobbler ob‐ │
269 │ │ jects (distros, profiles, │
270 │ │ systems, and repos) can │
271 │ │ take a --owners parameter │
272 │ │ to specify what Cobbler │
273 │ │ users can edit particular │
274 │ │ objects.This only applies │
275 │ │ to the Cobbler WebUI and │
276 │ │ XML-RPC interface, not the │
277 │ │ "cobbler" command line │
278 │ │ tool run from the shell. │
279 │ │ Furthermore, this is only │
280 │ │ respected by the au‐ │
281 │ │ thz_ownership module which │
282 │ │ must be enabled in │
283 │ │ /etc/cobbler/modules.conf. │
284 │ │ The value for --owners is │
285 │ │ a space separated list of │
286 │ │ users and groups as speci‐ │
287 │ │ fied in /etc/cob‐ │
288 │ │ bler/users.conf. For more │
289 │ │ information see the │
290 │ │ users.conf file as well as │
291 │ │ the Cobbler Wiki. In the │
292 │ │ default Cobbler configura‐ │
293 │ │ tion, this value is com‐ │
294 │ │ pletely ignored, as is │
295 │ │ users.conf. │
296 ├────────────────────┼────────────────────────────┤
297 │template-files │ This feature allows Cob‐ │
298 │ │ bler to be used as a con‐ │
299 │ │ figuration management sys‐ │
300 │ │ tem. The argument is a │
301 │ │ space delimited string of │
302 │ │ key=value pairs. Each key │
303 │ │ is the path to a template │
304 │ │ file, each value is the │
305 │ │ path to install the file │
306 │ │ on the system. This is de‐ │
307 │ │ scribed in further detail │
308 │ │ on the Cobbler Wiki and is │
309 │ │ implemented using special │
310 │ │ code in the post install. │
311 │ │ Koan also can retrieve │
312 │ │ these files from a Cobbler │
313 │ │ server on demand, effec‐ │
314 │ │ tively allowing Cobbler to │
315 │ │ function as a lightweight │
316 │ │ templated configuration │
317 │ │ management system. │
318 └────────────────────┴────────────────────────────┘
319 Cobbler profile
321 A profile associates a distribution to additional specialized options,
322 such as a installation automation file. Profiles are the core unit of
323 provisioning and at least one profile must exist for every distribution
324 to be provisioned. A profile might represent, for instance, a web
325 server or desktop configuration. In this way, profiles define a role to
326 be performed.
327 $ cobbler profile add --name=string --distro=string [--autoinst=path] [--kopts=string] [--ksmeta=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]
329 Arguments are the same as listed for distributions, save for the re‐
331 moval of "arch" and "breed", and with the additions listed below:
332 ┌────────────────────┬────────────────────────────┐
334 │Name │ Description │
335 ├────────────────────┼────────────────────────────┤
336 │name │ A descriptive name. This │
337 │ │ could be something like │
338 │ │ rhel5webservers or f9desk‐ │
339 │ │ tops. │
340 ├────────────────────┼────────────────────────────┤
341 │distro │ The name of a previously │
342 │ │ defined Cobbler distribu‐ │
343 │ │ tion. This value is re‐ │
344 │ │ quired. │
345 ├────────────────────┼────────────────────────────┤
346 │autoinst │ Local filesystem path to a │
347 │ │ automatic installation │
348 │ │ file, the file must reside │
349 │ │ under /var/lib/cobbler/au‐ │
350 │ │ toinstall_templates │
351 ├────────────────────┼────────────────────────────┤
352 │name-servers │ If your nameservers are │
353 │ │ not provided by DHCP, you │
354 │ │ can specify a space sepa‐ │
355 │ │ rated list of addresses │
356 │ │ here to configure each of │
357 │ │ the installed nodes to use │
358 │ │ them (provided the auto‐ │
359 │ │ matic installation files │
360 │ │ used are installed on a │
361 │ │ per-system basis). Users │
362 │ │ with DHCP setups should │
363 │ │ not need to use this op‐ │
364 │ │ tion. This is available to │
365 │ │ set in profiles to avoid │
366 │ │ having to set it repeat‐ │
367 │ │ edly for each system │
368 │ │ record. │
369 ├────────────────────┼────────────────────────────┤
370 │name-servers-search │ You can specify a space │
371 │ │ separated list of domain │
372 │ │ names to configure each of │
373 │ │ the installed nodes to use │
374 │ │ them as domain search │
375 │ │ path. This is available │
376 │ │ to set in profiles to │
377 │ │ avoid having to set it re‐ │
378 │ │ peatedly for each system │
379 │ │ record. │
380 ├────────────────────┼────────────────────────────┤
381 │virt-file-size │ (Virt-only) How large the │
382 │ │ disk image should be in │
383 │ │ Gigabytes. The default is │
384 │ │ 5. This can be a comma │
385 │ │ separated list (ex: 5,6,7) │
386 │ │ to allow for multiple │
387 │ │ disks of different sizes │
388 │ │ depending on what is given │
389 │ │ to --virt-path. This │
390 │ │ should be input as a inte‐ │
391 │ │ ger or decimal value with‐ │
392 │ │ out units. │
393 └────────────────────┴────────────────────────────┘
394 │virt-ram │ (Virt-only) How many │
398 │ │ megabytes of RAM to con‐ │
399 │ │ sume. The default is 512 │
400 │ │ MB. This should be input │
401 │ │ as an integer without │
402 │ │ units. │
403 ├────────────────────┼────────────────────────────┤
404 │virt-type │ (Virt-only) Koan can in‐ │
405 │ │ stall images using either │
406 │ │ Xen paravirt (xenpv) or │
407 │ │ QEMU/KVM (qemu). Choose │
408 │ │ one or the other strings │
409 │ │ to specify, or values will │
410 │ │ default to attempting to │
411 │ │ find a compatible instal‐ │
412 │ │ lation type on the client │
413 │ │ system("auto"). See the │
414 │ │ "Koan" manpage for more │
415 │ │ documentation. The default │
416 │ │ --virt-type can be config‐ │
417 │ │ ured in the Cobbler set‐ │
418 │ │ tings file such that this │
419 │ │ parameter does not have to │
420 │ │ be provided. Other virtu‐ │
421 │ │ alization types are sup‐ │
422 │ │ ported, for information on │
423 │ │ those options (such as │
424 │ │ VMware), see the Cobbler │
425 │ │ Wiki. │
426 ├────────────────────┼────────────────────────────┤
427 │virt-cpus │ (Virt-only) How many vir‐ │
428 │ │ tual CPUs should Koan give │
429 │ │ the virtual machine? The │
430 │ │ default is 1. This is an │
431 │ │ integer. │
432 ├────────────────────┼────────────────────────────┤
433 │virt-path │ (Virt-only) Where to store │
434 │ │ the virtual image on the │
435 │ │ host system. Except for │
436 │ │ advanced cases, this pa‐ │
437 │ │ rameter can usually be │
438 │ │ omitted. For disk images, │
439 │ │ the value is usually an │
440 │ │ absolute path to an exist‐ │
441 │ │ ing directory with an op‐ │
442 │ │ tional filename component. │
443 │ │ There is support for spec‐ │
444 │ │ ifying partitions │
445 │ │ /dev/sda4 or volume groups │
446 │ │ VolGroup00, etc. │
447 ├────────────────────┼────────────────────────────┤
448 │ │ For multiple disks, sepa‐ │
449 │ │ rate the values with com‐ │
450 │ │ mas such as Vol‐ │
451 │ │ Group00,VolGroup00 or │
452 │ │ /dev/sda4,/dev/sda5. Both │
453 │ │ those examples would cre‐ │
454 │ │ ate two disks for the VM. │
455 └────────────────────┴────────────────────────────┘
456 │virt-bridge │ (Virt-only) This specifies │
464 │ │ the default bridge to use │
465 │ │ for all systems defined │
466 │ │ under this profile. If not │
467 │ │ specified, it will assume │
468 │ │ the default value in the │
469 │ │ Cobbler settings file, │
470 │ │ which as shipped in the │
471 │ │ RPM is xenbr0. If using │
472 │ │ KVM, this is most likely │
473 │ │ not correct. You may want │
474 │ │ to override this setting │
475 │ │ in the system object. │
476 │ │ Bridge settings are impor‐ │
477 │ │ tant as they define how │
478 │ │ outside networking will │
479 │ │ reach the guest. For more │
480 │ │ information on bridge │
481 │ │ setup, see the Cobbler │
482 │ │ Wiki, where there is a │
483 │ │ section describing Koan │
484 │ │ usage. │
485 ├────────────────────┼────────────────────────────┤
486 │repos │ This is a space delimited │
487 │ │ list of all the repos │
488 │ │ (created with cobbler repo │
489 │ │ add and updated with cob‐ │
490 │ │ bler reposync)that this │
491 │ │ profile can make use of │
492 │ │ during automated installa‐ │
493 │ │ tion. For example, an ex‐ │
494 │ │ ample might be --re‐ │
495 │ │ pos="fc6i386updates │
496 │ │ fc6i386extras" if the pro‐ │
497 │ │ file wants to access these │
498 │ │ two mirrors that are al‐ │
499 │ │ ready mirrored on the Cob‐ │
500 │ │ bler server. Repo manage‐ │
501 │ │ ment is described in │
502 │ │ greater depth later in the │
503 │ │ manpage. │
504 ├────────────────────┼────────────────────────────┤
505 │parent │ This is an advanced fea‐ │
506 │ │ ture. │
507 ├────────────────────┼────────────────────────────┤
508 │ │ Profiles may inherit from │
509 │ │ other profiles in lieu of │
510 │ │ specifying --distro. In‐ │
511 │ │ herited profiles will │
512 │ │ override any settings │
513 │ │ specified in their parent, │
514 │ │ with the exception of │
515 │ │ --ksmeta (templating) and │
516 │ │ --kopts (kernel options), │
517 │ │ which will be blended to‐ │
518 │ │ gether. │
519 ├────────────────────┼────────────────────────────┤
520 │ │ Example: If profile A has │
521 │ │ --kopts="x=7 y=2", B in‐ │
522 │ │ herits from A, and B has │
523 │ │ --kopts="x=9 z=2", the ac‐ │
524 │ │ tual kernel options that │
525 │ │ will be used for B are x=9 │
526 │ │ y=2 z=2. │
527 └────────────────────┴────────────────────────────┘
528 │ │ Example: If profile B has │
530 │ │ --virt-ram=256 and A has │
531 │ │ --virt-ram=512, profile B │
532 │ │ will use the value 256. │
533 ├────────────────────┼────────────────────────────┤
534 │ │ Example: If profile A has │
535 │ │ a --virt-file-size=5 and B │
536 │ │ does not specify a size, B │
537 │ │ will use the value from A. │
538 ├────────────────────┼────────────────────────────┤
539 │server │ This parameter should be │
540 │ │ useful only in select cir‐ │
541 │ │ cumstances. If machines │
542 │ │ are on a subnet that can‐ │
543 │ │ not access the Cobbler │
544 │ │ server using the name/IP │
545 │ │ as configured in the Cob‐ │
546 │ │ bler settings file, use │
547 │ │ this parameter to override │
548 │ │ that servername. See also │
549 │ │ --dhcp-tag for configuring │
550 │ │ the next server and DHCP │
551 │ │ information of the system │
552 │ │ if you are also using Cob‐ │
553 │ │ bler to help manage your │
554 │ │ DHCP configuration. │
555 ├────────────────────┼────────────────────────────┤
556 │filename │ This parameter can be used │
557 │ │ to select the bootloader │
558 │ │ for network boot. If spec‐ │
559 │ │ ified, this must be a path │
560 │ │ relative to the TFTP │
561 │ │ servers root directory. │
562 │ │ (e.g. grub/grubx64.efi) │
563 │ │ For most use cases the de‐ │
564 │ │ fault bootloader is cor‐ │
565 │ │ rect and this can be omit‐ │
566 │ │ ted │
567 └────────────────────┴────────────────────────────┘
568 Cobbler system
570 System records map a piece of hardware (or a virtual machine) with the
571 Cobbler profile to be assigned to run on it. This may be thought of as
572 choosing a role for a specific system.
573 Note that if provisioning via Koan and PXE menus alone, it is not re‐
575 quired to create system records in Cobbler, though they are useful when
576 system specific customizations are required. One such customization
577 would be defining the MAC address. If there is a specific role intended
578 for a given machine, system records should be created for it.
579 System commands have a wider variety of control offered over network
581 details. In order to use these to the fullest possible extent, the au‐
582 tomatic installation template used by Cobbler must contain certain au‐
583 tomatic installation snippets (sections of code specifically written
584 for Cobbler to make these values become reality). Compare your auto‐
585 matic installation templates with the stock ones in /var/lib/cob‐
586 bler/autoinstall_templates if you have upgraded, to make sure you can
587 take advantage of all options to their fullest potential. If you are a
588 new Cobbler user, base your automatic installation templates off of
589 these templates.
590 Read more about networking setup at:
592 https://cobbler.readthedocs.io/en/release28/4_advanced/advanced%20networking.html
593 Example:
595 $ cobbler system add --name=string --profile=string [--mac=macaddress] [--ip-address=ipaddress] [--hostname=hostname] [--kopts=string] [--ksmeta=string] [--autoinst=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]
597 Adds a Cobbler System to the configuration. Arguments are specified as
599 per "profile add" with the following changes:
600┌───────────────────────────┬─────────────────────────────────────────────────────────────┐
602│Name │ Description │
603├───────────────────────────┼─────────────────────────────────────────────────────────────┤
604│name │ The system name works like │
605│ │ the name option for other │
606│ │ commands. │
607├───────────────────────────┼─────────────────────────────────────────────────────────────┤
608│ │ If the name looks like a │
609│ │ MAC address or an IP, the │
610│ │ name will implicitly be │
611│ │ used for either --mac or │
612│ │ --ip of the first inter‐ │
613│ │ face, respectively. How‐ │
614│ │ ever, it's usually better │
615│ │ to give a descriptive name │
616│ │ -- don't rely on this be‐ │
617│ │ havior. │
618├───────────────────────────┼─────────────────────────────────────────────────────────────┤
619│ │ A system created with name │
620│ │ "default" has special se‐ │
621│ │ mantics. If a default sys‐ │
622│ │ tem object exists, it sets │
623│ │ all undefined systems to │
624│ │ PXE to a specific profile. │
625│ │ Without a "default" system │
626│ │ name created, PXE will │
627│ │ fall through to local boot │
628│ │ for unconfigured systems. │
629├───────────────────────────┼─────────────────────────────────────────────────────────────┤
630│ │ When using "default" name, │
631│ │ don't specify any other │
632│ │ arguments than --profile │
633│ │ ... they won't be used. │
634├───────────────────────────┼─────────────────────────────────────────────────────────────┤
635│mac │ Specifying a mac address │
636│ │ via --mac allows the sys‐ │
637│ │ tem object to boot di‐ │
638│ │ rectly to a specific pro‐ │
639│ │ file via PXE, bypassing │
640│ │ Cobbler's PXE menu. If │
641│ │ the name of the Cobbler │
642│ │ system already looks like │
643│ │ a mac address, this is in‐ │
644│ │ ferred from the system │
645│ │ name and does not need to │
646│ │ be specified. │
647├───────────────────────────┼─────────────────────────────────────────────────────────────┤
648│ │ MAC addresses have the │
649│ │ format AA:BB:CC:DD:EE:FF. │
650│ │ It's highly recommended to │
651│ │ register your MAC-ad‐ │
652│ │ dresses in Cobbler if │
653│ │ you're using static ad‐ │
654│ │ dressing with multiple in‐ │
655│ │ terfaces, or if you are │
656│ │ using any of the advanced │
657│ │ networking features like │
658│ │ bonding, bridges or VLANs. │
659└───────────────────────────┴─────────────────────────────────────────────────────────────┘
660│ │ Cobbler does contain a │
662│ │ feature (enabled in │
663│ │ /etc/cobbler/settings) │
664│ │ that can automatically add │
665│ │ new system records when it │
666│ │ finds profiles being pro‐ │
667│ │ visioned on hardware it │
668│ │ has seen before. This may │
669│ │ help if you do not have a │
670│ │ report of all the MAC ad‐ │
671│ │ dresses in your datacen‐ │
672│ │ ter/lab configuration. │
673├───────────────────────────┼─────────────────────────────────────────────────────────────┤
674│ip-address │ If Cobbler is configured │
675│ │ to generate a DHCP config‐ │
676│ │ uration (see advanced sec‐ │
677│ │ tion), use this setting to │
678│ │ define a specific IP for │
679│ │ this system in DHCP. │
680│ │ Leaving off this parameter │
681│ │ will result in no DHCP │
682│ │ management for this par‐ │
683│ │ ticular system. │
684├───────────────────────────┼─────────────────────────────────────────────────────────────┤
685│ │ Example: --ip-ad‐ │
686│ │ dress=192.168.1.50 │
687├───────────────────────────┼─────────────────────────────────────────────────────────────┤
688│ │ If DHCP management is dis‐ │
689│ │ abled and the interface is │
690│ │ labelled --static=1, this │
691│ │ setting will be used for │
692│ │ static IP configuration. │
693├───────────────────────────┼─────────────────────────────────────────────────────────────┤
694│ │ Special feature: To con‐ │
695│ │ trol the default PXE be‐ │
696│ │ havior for an entire sub‐ │
697│ │ net, this field can also │
698│ │ be passed in using CIDR │
699│ │ notation. If --ip is │
700│ │ CIDR, do not specify any │
701│ │ other arguments other than │
702│ │ --name and --profile. │
703├───────────────────────────┼─────────────────────────────────────────────────────────────┤
704│ │ When using the CIDR nota‐ │
705│ │ tion trick, don't specify │
706│ │ any arguments other than │
707│ │ --name and --profile... │
708│ │ they won't be used. │
709├───────────────────────────┼─────────────────────────────────────────────────────────────┤
710│dns-name │ If using the DNS manage‐ │
711│ │ ment feature (see advanced │
712│ │ section -- Cobbler sup‐ │
713│ │ ports auto-setup of BIND │
714│ │ and dnsmasq), use this to │
715│ │ define a hostname for the │
716│ │ system to receive from │
717│ │ DNS. │
718├───────────────────────────┼─────────────────────────────────────────────────────────────┤
719│ │ Example: --dns-name=mycom‐ │
720│ │ puter.example.com │
721└───────────────────────────┴─────────────────────────────────────────────────────────────┘
722│ │ This is a per-interface │
728│ │ parameter. If you have │
729│ │ multiple interfaces, it │
730│ │ may be different for each │
731│ │ interface, for example, │
732│ │ assume a DMZ / dual-homed │
733│ │ setup. │
734├───────────────────────────┼─────────────────────────────────────────────────────────────┤
735│gateway and netmask │ If you are using static IP │
736│ │ configurations and the in‐ │
737│ │ terface is flagged │
738│ │ --static=1, these will be │
739│ │ applied. │
740├───────────────────────────┼─────────────────────────────────────────────────────────────┤
741│ │ Netmask is a per-interface │
742│ │ parameter. Because of the │
743│ │ way gateway is stored on │
744│ │ the installed OS, gateway │
745│ │ is a global parameter. You │
746│ │ may use --static-routes │
747│ │ for per-interface cus‐ │
748│ │ tomizations if required. │
749├───────────────────────────┼─────────────────────────────────────────────────────────────┤
750│if-gateway │ If you are using static IP │
751│ │ configurations and have │
752│ │ multiple interfaces, use │
753│ │ this to define different │
754│ │ gateway for each inter‐ │
755│ │ face. │
756├───────────────────────────┼─────────────────────────────────────────────────────────────┤
757│ │ This is a per-interface │
758│ │ setting. │
759├───────────────────────────┼─────────────────────────────────────────────────────────────┤
760│hostname │ This field corresponds to │
761│ │ the hostname set in a sys‐ │
762│ │ tems /etc/sysconfig/net‐ │
763│ │ work file. This has no │
764│ │ bearing on DNS, even when │
765│ │ manage_dns is enabled. │
766│ │ Use --dns-name instead for │
767│ │ that feature. │
768├───────────────────────────┼─────────────────────────────────────────────────────────────┤
769│ │ This parameter is assigned │
770│ │ once per system, it is not │
771│ │ a per-interface setting. │
772├───────────────────────────┼─────────────────────────────────────────────────────────────┤
773│power-address, power-type, │ Cobbler contains features │
774│power-user, power-pass, │ that enable integration │
775│power-id │ with power management for │
776│ │ easier installation, rein‐ │
777│ │ stallation, and management │
778│ │ of machines in a datacen‐ │
779│ │ ter environment. These │
780│ │ parameters are described │
781│ │ online at power-manage‐ │
782│ │ ment. If you have a │
783│ │ power-managed datacen‐ │
784│ │ ter/lab setup, usage of │
785│ │ these features may be │
786│ │ something you are inter‐ │
787│ │ ested in. │
788└───────────────────────────┴─────────────────────────────────────────────────────────────┘
789│static │ Indicates that this inter‐ │
794│ │ face is statically config‐ │
795│ │ ured. Many fields (such │
796│ │ as gateway/netmask) will │
797│ │ not be used unless this │
798│ │ field is enabled. │
799├───────────────────────────┼─────────────────────────────────────────────────────────────┤
800│ │ This is a per-interface │
801│ │ setting. │
802├───────────────────────────┼─────────────────────────────────────────────────────────────┤
803│static-routes │ This is a space delimited │
804│ │ list of ip/mask:gateway │
805│ │ routing information in │
806│ │ that format. Most systems │
807│ │ will not need this infor‐ │
808│ │ mation. │
809├───────────────────────────┼─────────────────────────────────────────────────────────────┤
810│ │ This is a per-interface │
811│ │ setting. │
812├───────────────────────────┼─────────────────────────────────────────────────────────────┤
813│virt-bridge │ (Virt-only) While │
814│ │ --virt-bridge is present │
815│ │ in the profile object (see │
816│ │ above), here it works on │
817│ │ an interface by interface │
818│ │ basis. For instance it │
819│ │ would be possible to have │
820│ │ --virt-bridge0=xenbr0 and │
821│ │ --virt-bridge1=xenbr1. If │
822│ │ not specified in Cobbler │
823│ │ for each interface, Koan │
824│ │ will use the value as │
825│ │ specified in the profile │
826│ │ for each interface, which │
827│ │ may not always be what is │
828│ │ intended, but will be suf‐ │
829│ │ ficient in most cases. │
830├───────────────────────────┼─────────────────────────────────────────────────────────────┤
831│ │ This is a per-interface │
832│ │ setting. │
833└───────────────────────────┴─────────────────────────────────────────────────────────────┘
834│autoinst │ While it is recommended │
860│ │ that the --autoinst param‐ │
861│ │ eter is only used within │
862│ │ for the "profile add" com‐ │
863│ │ mand, there are limited │
864│ │ scenarios when an install │
865│ │ base switching to Cobbler │
866│ │ may have legacy automatic │
867│ │ installation files created │
868│ │ on aper-system basis (one │
869│ │ automatic installation │
870│ │ file for each system, │
871│ │ nothing shared) and may │
872│ │ not want to immediately │
873│ │ make use of the Cobbler │
874│ │ templating system. This │
875│ │ allows specifying a auto‐ │
876│ │ matic installation file │
877│ │ for use on a per-system │
878│ │ basis. Creation of a par‐ │
879│ │ ent profile is still re‐ │
880│ │ quired. If the automatic │
881│ │ installation file is a │
882│ │ filesystem location, it │
883│ │ will still be treated as a │
884│ │ Cobbler template. │
885├───────────────────────────┼─────────────────────────────────────────────────────────────┤
886│netboot-enabled │ If set false, the system │
887│ │ will be provisionable │
888│ │ through Koan but not │
889│ │ through standard PXE. This │
890│ │ will allow the system to │
891│ │ fall back to default PXE │
892│ │ boot behavior without │
893│ │ deleting the Cobbler sys‐ │
894│ │ tem object. The default │
895│ │ value allows PXE. Cobbler │
896│ │ contains a PXE boot loop │
897│ │ prevention feature │
898│ │ (pxe_just_once, can be en‐ │
899│ │ abled in /etc/cobbler/set‐ │
900│ │ tings) that can automati‐ │
901│ │ cally trip off this value │
902│ │ after a system gets done │
903│ │ installing. This can pre‐ │
904│ │ vent installs from appear‐ │
905│ │ ing in an endless loop │
906│ │ when the system is set to │
907│ │ PXE first in the BIOS or‐ │
908│ │ der. │
909├───────────────────────────┼─────────────────────────────────────────────────────────────┤
910│repos-enabled │ If set true, Koan can re‐ │
911│ │ configure repositories af‐ │
912│ │ ter installation. This is │
913│ │ described further on the │
914│ │ Cobbler │
915│ │ Wiki,https://github.com/cob‐ │
916│ │ bler/cobbler/wiki/Man‐ │
917│ │ age-yum-repos. │
918└───────────────────────────┴─────────────────────────────────────────────────────────────┘
919│dhcp-tag │ If you are setting up a PXE │
926│ │ environment with multiple │
927│ │ subnets/gateways, and are │
928│ │ using Cobbler to manage a │
929│ │ DHCP configuration, you will │
930│ │ probably want to use this │
931│ │ option. If not, it can be │
932│ │ ignored. │
933├───────────────────────────┼─────────────────────────────────────────────────────────────┤
934│ │ By default, the dhcp tag for │
935│ │ all systems is "default" and │
936│ │ means that in the DHCP tem‐ │
937│ │ plate files the systems will │
938│ │ expand out where $in‐ │
939│ │ sert_cobbler_systems_defini‐ │
940│ │ tions is found in the DHCP │
941│ │ template. However, you may │
942│ │ want certain systems to ex‐ │
943│ │ pand out in other places in │
944│ │ the DHCP config file. Set‐ │
945│ │ ting --dhcp-tag=subnet2 for │
946│ │ instance, will cause that │
947│ │ system to expand out where │
948│ │ $insert_cobbler_system_defi‐ │
949│ │ nitions_subnet2 is found, │
950│ │ allowing you to insert di‐ │
951│ │ rectives to specify differ‐ │
952│ │ ent subnets (or other param‐ │
953│ │ eters) before the DHCP con‐ │
954│ │ figuration entries for those │
955│ │ particular systems. │
956├───────────────────────────┼─────────────────────────────────────────────────────────────┤
957│ │ This is described further on │
958│ │ the Cobbler Wiki. │
959├───────────────────────────┼─────────────────────────────────────────────────────────────┤
960│interface │ By default flags like --ip, │
961│ │ --mac, --dhcp-tag, │
962│ │ --dns-name, --netmask, │
963│ │ --virt-bridge, and │
964│ │ --static-routes operate on │
965│ │ the first network interface │
966│ │ defined for a system (eth0). │
967│ │ However, Cobbler supports an │
968│ │ arbitrary number of inter‐ │
969│ │ faces. Using--interface=eth1 │
970│ │ for instance, will allow │
971│ │ creating and editing of a │
972│ │ second interface. │
973├───────────────────────────┼─────────────────────────────────────────────────────────────┤
974│ │ Interface naming notes: │
975├───────────────────────────┼─────────────────────────────────────────────────────────────┤
976│ │ Additional interfaces can be │
977│ │ specified (for example: │
978│ │ eth1, or any name you like, │
979│ │ as long as it does not con‐ │
980│ │ flict with any reserved │
981│ │ names such as kernel module │
982│ │ names) for use with the edit │
983│ │ command. Defining VLANs this │
984│ │ way is also supported, of │
985│ │ you want to add VLAN 5 on │
986│ │ interface eth0, simply name │
987│ │ your interface eth0.5. │
988└───────────────────────────┴─────────────────────────────────────────────────────────────┘
989│ │ Example: │
992├───────────────────────────┼─────────────────────────────────────────────────────────────┤
993│ │ cobbler system edit │
994│ │ --name=foo --ip-ad‐ │
995│ │ dress=192.168.1.50 │
996│ │ --mac=AA:BB:CC:DD:EE:A0 │
997├───────────────────────────┼─────────────────────────────────────────────────────────────┤
998│ │ cobbler system edit │
999│ │ --name=foo --interface=eth0 │
1000│ │ --ip-address=192.168.1.51 │
1001│ │ --mac=AA:BB:CC:DD:EE:A1 │
1002├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1003│ │ cobbler system report foo │
1004├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1005│ │ Interfaces can be deleted │
1006│ │ using the --delete-interface │
1007│ │ option. │
1008├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1009│ │ Example: │
1010├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1011│ │ cobbler system edit │
1012│ │ --name=foo --interface=eth2 │
1013│ │ --delete-interface │
1014├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1015│interface-type, inter‐ │ One of the other advanced │
1016│face-master and bond‐ │ networking features sup‐ │
1017│ing-opts/bridge-opts │ ported by Cobbler is NIC │
1018│ │ bonding, bridging and BMC. │
1019│ │ You can use this to bond │
1020│ │ multiple physical network │
1021│ │ interfaces to one single │
1022│ │ logical interface to reduce │
1023│ │ single points of failure in │
1024│ │ your network, to create │
1025│ │ bridged interfaces for │
1026│ │ things like tunnels and vir‐ │
1027│ │ tual machine networks, or to │
1028│ │ manage BMC interface by │
1029│ │ DHCP. Supported values for │
1030│ │ the --interface-type parame‐ │
1031│ │ ter are "bond", │
1032│ │ "bond_slave", "bridge", │
1033│ │ "bridge_slave","bonded_bridge_slave" │
1034│ │ and "bmc". If one of the │
1035│ │ "_slave" options is speci‐ │
1036│ │ fied, you also need to de‐ │
1037│ │ fine the master-interface │
1038│ │ for this bond using --inter‐ │
1039│ │ face-master=INTERFACE. Bond‐ │
1040│ │ ing and bridge options for │
1041│ │ the master-interface may be │
1042│ │ specified using --bond‐ │
1043│ │ ing-opts="foo=1 bar=2" or │
1044│ │ --bridge-opts="foo=1 bar=2". │
1045├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1046│ │ Example: │
1047├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1048│ │ cobbler system edit --name=foo --in‐ │
1049│ │ terface=eth0 --mac=AA:BB:CC:DD:EE:00 │
1050│ │ --interface-type=bond_slave --inter‐ │
1051│ │ face-master=bond0 │
1052└───────────────────────────┴─────────────────────────────────────────────────────────────┘
1053│ │ cobbler system edit --name=foo --in‐ │
1058│ │ terface=eth1 --mac=AA:BB:CC:DD:EE:01 │
1059│ │ --interface-type=bond_slave --inter‐ │
1060│ │ face-master=bond0 │
1061├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1062│ │ cobbler system edit --name=foo --in‐ │
1063│ │ terface=bond0 --interface-type=bond │
1064│ │ --bonding-opts="mode=active-backup │
1065│ │ miimon=100" --ip-ad‐ │
1066│ │ dress=192.168.0.63 --net‐ │
1067│ │ mask=255.255.255.0 --gate‐ │
1068│ │ way=192.168.0.1 --static=1 │
1069├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1070│ │ More information about networking │
1071│ │ setup is available at │
1072│ │ https://github.com/cobbler/cobbler/wiki/Advanced-networking │
1073├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1074│ │ To review what networking configuration you have for any │
1075│ │ object, run "cobbler system report" at any time: │
1076├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1077│ │ Example: │
1078├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1079│ │ cobbler system report --name=foo │
1080└───────────────────────────┴─────────────────────────────────────────────────────────────┘
1081 Cobbler repo
1083 Repository mirroring allows Cobbler to mirror not only install trees
1084 ("cobbler import" does this for you) but also optional packages, 3rd
1085 party content, and even updates. Mirroring all of this content locally
1086 on your network will result in faster, more up-to-date installations
1087 and faster updates. If you are only provisioning a home setup, this
1088 will probably be overkill, though it can be very useful for larger set‐
1089 ups (labs, datacenters, etc).
1090 $ 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]
1092 ┌─────────────────┬──────────────────────────────┐
1094 │Name │ Description │
1095 ├─────────────────┼──────────────────────────────┤
1096 │mirror │ The address of the yum │
1097 │ │ mirror. This can be an │
1098 │ │ rsync://-URL, an ssh loca‐ │
1099 │ │ tion, or a http:// or │
1100 │ │ ftp:// mirror location. │
1101 │ │ Filesystem paths also │
1102 │ │ work. │
1103 ├─────────────────┼──────────────────────────────┤
1104 │ │ The mirror address should │
1105 │ │ specify an exact reposi‐ │
1106 │ │ tory to mirror -- just one │
1107 │ │ architecture and just one │
1108 │ │ distribution. If you have │
1109 │ │ a separate repo to mirror │
1110 │ │ for a different arch, add │
1111 │ │ that repo separately. │
1112 ├─────────────────┼──────────────────────────────┤
1113 │ │ Here's an example of what │
1114 │ │ looks like a good URL: │
1115 └─────────────────┴──────────────────────────────┘
1116 │ │ │
1124 │ │ • rsync://yourmir‐ │
1125 │ │ ror.exam‐ │
1126 │ │ ple.com/fe‐ │
1127 │ │ dora-linux-core/up‐ │
1128 │ │ dates/6/i386 (for │
1129 │ │ rsync protocol) │
1130 │ │ │
1131 │ │ • http://mir‐ │
1132 │ │ rors.ker‐ │
1133 │ │ nel.org/fe‐ │
1134 │ │ dora/ex‐ │
1135 │ │ tras/6/i386/ (for │
1136 │ │ http) │
1137 │ │ │
1138 │ │ • user@yourmir‐ │
1139 │ │ ror.exam‐ │
1140 │ │ ple.com/fe‐ │
1141 │ │ dora-linux-core/up‐ │
1142 │ │ dates/6/i386 │
1143 │ │ (for SSH) │
1144 ├─────────────────┼──────────────────────────────┤
1145 │ │ Experimental support is also │
1146 │ │ provided for mirroring RHN │
1147 │ │ content when you need a fast │
1148 │ │ local mirror. The mirror │
1149 │ │ syntax for this is --mir‐ │
1150 │ │ ror=rhn://channel-name and │
1151 │ │ you must have entitlements │
1152 │ │ for this to work. This re‐ │
1153 │ │ quires the Cobbler server to │
1154 │ │ be installed on RHEL 5 or │
1155 │ │ later. You will also need a │
1156 │ │ version of yum-utils equal │
1157 │ │ or greater to 1.0.4. │
1158 ├─────────────────┼──────────────────────────────┤
1159 │name │ This name is used as the │
1160 │ │ save location for the mir‐ │
1161 │ │ ror. If the mirror repre‐ │
1162 │ │ sented, say, Fedora Core 6 │
1163 │ │ i386 updates, a good name │
1164 │ │ would be fc6i386updates. │
1165 │ │ Again, be specific. │
1166 ├─────────────────┼──────────────────────────────┤
1167 │ │ This name corresponds with │
1168 │ │ values given to the --repos │
1169 │ │ parameter of cobbler profile │
1170 │ │ add. If a profile has a │
1171 │ │ --repos-value that matches │
1172 │ │ the name given here, that │
1173 │ │ repo can be automatically │
1174 │ │ set up during provisioning │
1175 │ │ (when supported) and in‐ │
1176 │ │ stalled systems will also │
1177 │ │ use the boot server as a │
1178 │ │ mirror (unless yum_post_in‐ │
1179 │ │ stall_mirror is disabled in │
1180 │ │ the settings file). By de‐ │
1181 │ │ fault the provisioning │
1182 │ │ server will act as a mirror │
1183 │ │ to systems it installs, │
1184 │ │ which may not be desirable │
1185 │ │ for laptop configurations, │
1186 │ │ etc. │
1187 └─────────────────┴──────────────────────────────┘
1188 │ │ Distros that can make use of │
1190 │ │ yum repositories during au‐ │
1191 │ │ tomatic installation include │
1192 │ │ FC6 and later, RHEL 5 and │
1193 │ │ later, and derivative dis‐ │
1194 │ │ tributions. │
1195 ├─────────────────┼──────────────────────────────┤
1196 │ │ See the documentation on │
1197 │ │ cobbler profile add for more │
1198 │ │ information. │
1199 ├─────────────────┼──────────────────────────────┤
1200 │rpm-list │ By specifying a space-delim‐ │
1201 │ │ ited list of package names │
1202 │ │ for --rpm-list, one can de‐ │
1203 │ │ cide to mirror only a part │
1204 │ │ of a repo (the list of pack‐ │
1205 │ │ ages given, plus dependen‐ │
1206 │ │ cies). This may be helpful │
1207 │ │ in conserving │
1208 │ │ time/space/bandwidth. For │
1209 │ │ instance, when mirroring FC6 │
1210 │ │ Extras, it may be desired to │
1211 │ │ mirror just Cobbler and │
1212 │ │ Koan, and skip all of the │
1213 │ │ game packages. To do this, │
1214 │ │ use --rpm-list="cobbler │
1215 │ │ koan". │
1216 ├─────────────────┼──────────────────────────────┤
1217 │ │ This option only works for │
1218 │ │ http:// and ftp:// reposito‐ │
1219 │ │ ries (as it is powered by │
1220 │ │ yumdownloader). It will be │
1221 │ │ ignored for other mirror │
1222 │ │ types, such as local paths │
1223 │ │ and rsync:// mirrors. │
1224 ├─────────────────┼──────────────────────────────┤
1225 │createrepo-flags │ Specifies optional flags to │
1226 │ │ feed into the createrepo │
1227 │ │ tool, which is called when │
1228 │ │ cobbler reposync is run for │
1229 │ │ the given repository. The │
1230 │ │ defaults are -c cache. │
1231 ├─────────────────┼──────────────────────────────┤
1232 │keep-updated │ Specifies that the named │
1233 │ │ repository should not be up‐ │
1234 │ │ dated during a normal "cob‐ │
1235 │ │ bler reposync". The repo may │
1236 │ │ still be updated by name. │
1237 │ │ The repo should be synced at │
1238 │ │ least once before disabling │
1239 │ │ this feature. See "cobbler │
1240 │ │ reposync" below. │
1241 ├─────────────────┼──────────────────────────────┤
1242 │mirror-locally │ When set to N, specifies │
1243 │ │ that this yum repo is to be │
1244 │ │ referenced directly via au‐ │
1245 │ │ tomatic installation files │
1246 │ │ and not mirrored locally on │
1247 │ │ the Cobbler server. Only │
1248 │ │ http:// and ftp:// mirror │
1249 │ │ urls are supported when us‐ │
1250 │ │ ing --mirror-locally=N, you │
1251 │ │ cannot use filesystem URLs. │
1252 └─────────────────┴──────────────────────────────┘
1253 │priority │ Specifies the priority of │
1256 │ │ the repository (the lower │
1257 │ │ the number, the higher the │
1258 │ │ priority), which applies to │
1259 │ │ installed machines using the │
1260 │ │ repositories that also have │
1261 │ │ the yum priorities plugin │
1262 │ │ installed. The default pri‐ │
1263 │ │ ority for the plugins 99, as │
1264 │ │ is that of all Cobbler mir‐ │
1265 │ │ rored repositories. │
1266 ├─────────────────┼──────────────────────────────┤
1267 │arch │ Specifies what architecture │
1268 │ │ the repository should use. │
1269 │ │ By default the current sys‐ │
1270 │ │ tem arch (of the server) is │
1271 │ │ used,which may not be desir‐ │
1272 │ │ able. Using this to override │
1273 │ │ the default arch allows mir‐ │
1274 │ │ roring of source reposito‐ │
1275 │ │ ries(using --arch=src). │
1276 ├─────────────────┼──────────────────────────────┤
1277 │yumopts │ Sets values for additional │
1278 │ │ yum options that the repo │
1279 │ │ should use on installed sys‐ │
1280 │ │ tems. For instance if a yum │
1281 │ │ plugin takes a certain pa‐ │
1282 │ │ rameter "alpha" and "beta", │
1283 │ │ use something like --yu‐ │
1284 │ │ mopts="alpha=2 beta=3". │
1285 ├─────────────────┼──────────────────────────────┤
1286 │breed │ Ordinarily Cobbler's repo │
1287 │ │ system will understand what │
1288 │ │ you mean without supplying │
1289 │ │ this parameter, though you │
1290 │ │ can set it explicitly if │
1291 │ │ needed. │
1292 └─────────────────┴──────────────────────────────┘
1293 Cobbler image
1295 Example:
1296 $ cobbler image
1298 cobbler mgmtclass
1300 Management classes allows Cobbler to function as an configuration man‐
1301 agement system. Cobbler currently supports the following resource
1302 types:
1303 1. Packages
1305 2. Files
1307 Resources are executed in the order listed above.
1309 $ cobbler mgmtclass add --name=string --comment=string [--packages=list] [--files=list]
1311 ┌─────────┬────────────────────────────┐
1313 │Name │ Description │
1314 └─────────┴────────────────────────────┘
1315 │name │ The name of the mgmtclass. │
1322 │ │ Use this name when adding │
1323 │ │ a management class to a │
1324 │ │ system, profile, or dis‐ │
1325 │ │ tro. To add a mgmtclass │
1326 │ │ to an existing system use │
1327 │ │ something like (cobbler │
1328 │ │ system edit --name="mad‐ │
1329 │ │ hatter" │
1330 │ │ --mgmt-classes="http │
1331 │ │ mysql"). │
1332 ├─────────┼────────────────────────────┤
1333 │comment │ A comment that describes │
1334 │ │ the functions of the man‐ │
1335 │ │ agement class. │
1336 ├─────────┼────────────────────────────┤
1337 │packages │ Specifies a list of pack‐ │
1338 │ │ age resources required by │
1339 │ │ the management class. │
1340 ├─────────┼────────────────────────────┤
1341 │files │ Specifies a list of file │
1342 │ │ resources required by the │
1343 │ │ management class. │
1344 └─────────┴────────────────────────────┘
1345 Cobbler package
1347 Package resources are managed using cobbler package add
1348 Actions:
1350 ┌──────────┬────────────────────────────┐
1352 │Name │ Description │
1353 ├──────────┼────────────────────────────┤
1354 │install │ Install the package. [De‐ │
1355 │ │ fault] │
1356 ├──────────┼────────────────────────────┤
1357 │uninstall │ Uninstall the package. │
1358 └──────────┴────────────────────────────┘
1359 Attributes:
1361 ┌──────────┬────────────────────────────┐
1363 │Name │ Description │
1364 ├──────────┼────────────────────────────┤
1365 │installer │ Which package manager to │
1366 │ │ use, vaild options │
1367 │ │ [rpm|yum]. │
1368 ├──────────┼────────────────────────────┤
1369 │version │ Which version of the pack‐ │
1370 │ │ age to install. │
1371 └──────────┴────────────────────────────┘
1372 Example:
1374 $ cobbler package add --name=string --comment=string [--action=install|uninstall] --installer=string [--version=string]
1376 Cobbler file
1378 Actions:
1379 ┌───────┬────────────────────────────┐
1381 │Name │ Description │
1382 ├───────┼────────────────────────────┤
1383 │create │ Create the file. [Default] │
1384 └───────┴────────────────────────────┘
1385 │remove │ Remove the file. │
1388 └───────┴────────────────────────────┘
1389 Attributes:
1391 ┌─────────┬────────────────────────────┐
1393 │Name │ Description │
1394 ├─────────┼────────────────────────────┤
1395 │mode │ Permission mode (as in │
1396 │ │ chmod). │
1397 ├─────────┼────────────────────────────┤
1398 │group │ The group owner of the │
1399 │ │ file. │
1400 ├─────────┼────────────────────────────┤
1401 │user │ The user for the file. │
1402 ├─────────┼────────────────────────────┤
1403 │path │ The path for the file. │
1404 ├─────────┼────────────────────────────┤
1405 │template │ The template for the file. │
1406 └─────────┴────────────────────────────┘
1407 Example:
1409 $ cobbler file add --name=string --comment=string [--action=string] --mode=string --group=string --owner=string --path=string [--template=string]
1411 cobbler aclsetup
1413 Example:
1414 $ cobbler aclsetup
1416 Cobbler buildiso
1418 Example:
1419 $ cobbler buildiso
1421 Cobbler import
1423 Example:
1424 $ cobbler import
1426 Cobbler list
1428 This list all the names grouped by type. Identically to cobbler report
1429 there are subcommands for most of the other Cobbler commands. (Cur‐
1430 rently: distro, profile, system, repo, image, mgmtclass, package, file)
1431 $ cobbler list
1433 Cobbler replicate
1435 Cobbler can replicate configurations from a master Cobbler server. Each
1436 Cobbler server is still expected to have a locally relevant /etc/cob‐
1437 bler/cobbler.conf and modules.conf, as these files are not synced.
1438 This feature is intended for load-balancing, disaster-recovery, backup,
1440 or multiple geography support.
1441 Cobbler can replicate data from a central server.
1443 Objects that need to be replicated should be specified with a pattern,
1445 such as --profiles="webservers* dbservers*" or --systems="*.exam‐
1446 ple.org". All objects matched by the pattern, and all dependencies of
1447 those objects matched by the pattern (recursively) will be transferred
1448 from the remote server to the central server. This is to say if you in‐
1449 tend to transfer *.example.org and the definition of the systems have
1450 not changed, but a profile above them has changed, the changes to that
1451 profile will also be transferred.
1452 In the case where objects are more recent on the local server, those
1454 changes will not be overridden locally.
1455 Common data locations will be rsync'ed from the master server unless
1457 --omit-data is specified.
1458 To delete objects that are no longer present on the master server, use
1460 --prune.
1461 Warning: This will delete all object types not present on the remote
1463 server from the local server, and is recursive. If you use prune, it
1464 is best to manage Cobbler centrally and not expect changes made on the
1465 slave servers to be preserved. It is not currently possible to just
1466 prune objects of a specific type.
1467 Example:
1469 $ cobbler replicate --master=cobbler.example.org [--distros=pattern] [--profiles=pattern] [--systems=pattern] [--repos-pattern] [--images=pattern] [--prune] [--omit-data]
1471 Cobbler report
1473 This lists all configuration which Cobbler can obtain from the saved
1474 data. There are also report subcommands for most of the other Cobbler
1475 commands (currently: distro, profile, system, repo, image, mgmtclass,
1476 package, file).
1477 $ cobbler report --name=[object-name]
1479 --name=[object-name]
1481 Optional parameter which filters for object with the given name.
1483 Cobbler reposync
1485 Example:
1486 $ cobbler reposync
1488 Cobbler sync
1490 The sync command is very important, though very often unnecessary for
1491 most situations. It's primary purpose is to force a rewrite of all con‐
1492 figuration files, distribution files in the TFTP root, and to restart
1493 managed services. So why is it unnecessary? Because in most common sit‐
1494 uations (after an object is edited, for example), Cobbler executes what
1495 is known as a "lite sync" which rewrites most critical files.
1496 When is a full sync required? When you are using manage_dhcpd (Managing
1498 DHCP) with systems that use static leases. In that case, a full sync
1499 is required to rewrite the dhcpd.conf file and to restart the dhcpd
1500 service.
1501 Cobbler sync is used to repair or rebuild the contents /tftpboot or
1503 /var/www/cobbler when something has changed behind the scenes. It
1504 brings the filesystem up to date with the configuration as understood
1505 by Cobbler.
1506 Sync should be run whenever files in /var/lib/cobbler are manually
1508 edited (which is not recommended except for the settings file) or when
1509 making changes to automatic installation files. In practice, this
1510 should not happen often, though running sync too many times does not
1511 cause any adverse effects.
1512 If using Cobbler to manage a DHCP and/or DNS server (see the advanced
1514 section of this manpage), sync does need to be run after systems are
1515 added to regenerate and reload the DHCP/DNS configurations.
1516 The sync process can also be kicked off from the web interface.
1518 Example:
1520 $ cobbler sync
1522 Cobbler validate-autoinstalls
1524 Example:
1525 $ cobbler validate-autoinstalls
1527 Cobbler version
1529 Example:
1530 $ cobbler version
1532 Cobbler signature
1534 Example:
1535 $ cobbler signature
1537 Cobbler get-loaders
1539 Example:
1540 $ cobbler get-loaders
1542 Cobbler hardlink
1544 Example:
1545 $ cobbler hardlink
1547
1549 Cobbler's command line returns a zero for success and non-zero for
1550 failure.
1551
1553 We have a Gitter Channel and you also can ask questions as GitHub is‐
1554 sues. The IRC Channel on Freenode (#cobbler) is not that active but
1555 sometimes there are people who can help you.
1556 The way we would prefer are GitHub issues as they are easily search‐
1558 able.
1559
1561 Jörgen Maas
1562
1564 2021, Enno Gotthold
15653.2 Jan 26, 2021 COBBLER(1)