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
17 information 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 │
86 │ │ installation 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 │
94 │ │ below) will still be │
95 │ │ copied into the image │
96 │ │ directory of the TFTP │
97 │ │ server. The above kernel │
98 │ │ parameter is still needed │
99 │ │ (e.g. to build iso images, │
100 │ │ etc.). The advantage of │
101 │ │ letting the boot loader │
102 │ │ retrieve the kernel/initrd │
103 │ │ directly is the support of │
104 │ │ changing/updated distribu‐ │
105 │ │ tions. E.g. openSUSE Tum‐ │
106 │ │ bleweed is updated on the │
107 │ │ fly and 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 │
121 │ │ depending 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 │
147 │ │ exactly the same. This │
148 │ │ requires some special │
149 │ │ snippets to be found in │
150 │ │ your automatic installa‐ │
151 │ │ tion template in order for │
152 │ │ this to work. Automatic │
153 │ │ installation templating is │
154 │ │ described 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 │
202 │ │ arguments for automatic │
203 │ │ installation, 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 │
218 │ │ arguments 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 │
227 │ │ answer 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 │
236 │ │ instances when provision‐ │
237 │ │ ing 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 │
269 │ │ objects (distros, pro‐ │
270 │ │ files, systems, and repos) │
271 │ │ can take a --owners param‐ │
272 │ │ eter to specify what Cob‐ │
273 │ │ bler users can edit par‐ │
274 │ │ ticular objects.This only │
275 │ │ applies to the Cobbler │
276 │ │ WebUI and XML-RPC inter‐ │
277 │ │ face, not the "cobbler" │
278 │ │ command line tool run from │
279 │ │ the shell. Furthermore, │
280 │ │ this is only respected by │
281 │ │ the authz_ownership module │
282 │ │ which 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 │
307 │ │ described in further │
308 │ │ detail on the Cobbler Wiki │
309 │ │ and is implemented using │
310 │ │ special code in the post │
311 │ │ install. Koan also can │
312 │ │ retrieve these files from │
313 │ │ a Cobbler server on │
314 │ │ demand, effectively allow‐ │
315 │ │ ing Cobbler to function as │
316 │ │ a lightweight templated │
317 │ │ configuration management │
318 │ │ system. │
319 └────────────────────┴────────────────────────────┘
320 Cobbler profile
322 A profile associates a distribution to additional specialized options,
323 such as a installation automation file. Profiles are the core unit of
324 provisioning and at least one profile must exist for every distribution
325 to be provisioned. A profile might represent, for instance, a web
326 server or desktop configuration. In this way, profiles define a role to
327 be performed.
328 $ 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]
330 Arguments are the same as listed for distributions, save for the
332 removal of "arch" and "breed", and with the additions listed below:
333 ┌────────────────────┬────────────────────────────┐
335 │Name │ Description │
336 ├────────────────────┼────────────────────────────┤
337 │name │ A descriptive name. This │
338 │ │ could be something like │
339 │ │ rhel5webservers or f9desk‐ │
340 │ │ tops. │
341 ├────────────────────┼────────────────────────────┤
342 │distro │ The name of a previously │
343 │ │ defined Cobbler distribu‐ │
344 │ │ tion. This value is │
345 │ │ required. │
346 ├────────────────────┼────────────────────────────┤
347 │autoinst │ Local filesystem path to a │
348 │ │ automatic installation │
349 │ │ file, the file must reside │
350 │ │ under /var/lib/cob‐ │
351 │ │ bler/autoinstall_templates │
352 ├────────────────────┼────────────────────────────┤
353 │name-servers │ If your nameservers are │
354 │ │ not provided by DHCP, you │
355 │ │ can specify a space sepa‐ │
356 │ │ rated list of addresses │
357 │ │ here to configure each of │
358 │ │ the installed nodes to use │
359 │ │ them (provided the auto‐ │
360 │ │ matic installation files │
361 │ │ used are installed on a │
362 │ │ per-system basis). Users │
363 │ │ with DHCP setups should │
364 │ │ not need to use this │
365 │ │ option. This is available │
366 │ │ to set in profiles to │
367 │ │ avoid having to set it │
368 │ │ repeatedly for each system │
369 │ │ record. │
370 ├────────────────────┼────────────────────────────┤
371 │name-servers-search │ You can specify a space │
372 │ │ separated list of domain │
373 │ │ names to configure each of │
374 │ │ the installed nodes to use │
375 │ │ them as domain search │
376 │ │ path. This is available │
377 │ │ to set in profiles to │
378 │ │ avoid having to set it │
379 │ │ repeatedly for each system │
380 │ │ record. │
381 ├────────────────────┼────────────────────────────┤
382 │virt-file-size │ (Virt-only) How large the │
383 │ │ disk image should be in │
384 │ │ Gigabytes. The default is │
385 │ │ 5. This can be a comma │
386 │ │ separated list (ex: 5,6,7) │
387 │ │ to allow for multiple │
388 │ │ disks of different sizes │
389 │ │ depending on what is given │
390 │ │ to --virt-path. This │
391 │ │ should be input as a inte‐ │
392 │ │ ger or decimal value with‐ │
393 │ │ out units. │
394 └────────────────────┴────────────────────────────┘
395 │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 │
405 │ │ install images using │
406 │ │ either Xen paravirt │
407 │ │ (xenpv) or QEMU/KVM │
408 │ │ (qemu). Choose one or the │
409 │ │ other strings to specify, │
410 │ │ or values will default to │
411 │ │ attempting to find a com‐ │
412 │ │ patible installation type │
413 │ │ on the client sys‐ │
414 │ │ tem("auto"). See the │
415 │ │ "Koan" manpage for more │
416 │ │ documentation. The default │
417 │ │ --virt-type can be config‐ │
418 │ │ ured in the Cobbler set‐ │
419 │ │ tings file such that this │
420 │ │ parameter does not have to │
421 │ │ be provided. Other virtu‐ │
422 │ │ alization types are sup‐ │
423 │ │ ported, for information on │
424 │ │ those options (such as │
425 │ │ VMware), see the Cobbler │
426 │ │ Wiki. │
427 ├────────────────────┼────────────────────────────┤
428 │virt-cpus │ (Virt-only) How many vir‐ │
429 │ │ tual CPUs should Koan give │
430 │ │ the virtual machine? The │
431 │ │ default is 1. This is an │
432 │ │ integer. │
433 ├────────────────────┼────────────────────────────┤
434 │virt-path │ (Virt-only) Where to store │
435 │ │ the virtual image on the │
436 │ │ host system. Except for │
437 │ │ advanced cases, this │
438 │ │ parameter can usually be │
439 │ │ omitted. For disk images, │
440 │ │ the value is usually an │
441 │ │ absolute path to an exist‐ │
442 │ │ ing directory with an │
443 │ │ optional filename compo‐ │
444 │ │ nent. There is support for │
445 │ │ specifying partitions │
446 │ │ /dev/sda4 or volume groups │
447 │ │ VolGroup00, etc. │
448 ├────────────────────┼────────────────────────────┤
449 │ │ For multiple disks, sepa‐ │
450 │ │ rate the values with com‐ │
451 │ │ mas such as Vol‐ │
452 │ │ Group00,VolGroup00 or │
453 │ │ /dev/sda4,/dev/sda5. Both │
454 │ │ those examples would cre‐ │
455 │ │ ate two disks for the VM. │
456 └────────────────────┴────────────────────────────┘
457 │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 set‐ │
481 │ │ up, see the Cobbler Wiki, │
482 │ │ where there is a section │
483 │ │ describing Koan usage. │
484 ├────────────────────┼────────────────────────────┤
485 │repos │ This is a space delimited │
486 │ │ list of all the repos │
487 │ │ (created with cobbler repo │
488 │ │ add and updated with cob‐ │
489 │ │ bler reposync)that this │
490 │ │ profile can make use of │
491 │ │ during automated installa‐ │
492 │ │ tion. For example, an │
493 │ │ example might be │
494 │ │ --repos="fc6i386updates │
495 │ │ fc6i386extras" if the pro‐ │
496 │ │ file wants to access these │
497 │ │ two mirrors that are │
498 │ │ already mirrored on the │
499 │ │ Cobbler server. Repo man‐ │
500 │ │ agement is described in │
501 │ │ greater depth later in the │
502 │ │ manpage. │
503 ├────────────────────┼────────────────────────────┤
504 │parent │ This is an advanced fea‐ │
505 │ │ ture. │
506 ├────────────────────┼────────────────────────────┤
507 │ │ Profiles may inherit from │
508 │ │ other profiles in lieu of │
509 │ │ specifying --distro. │
510 │ │ Inherited profiles will │
511 │ │ override any settings │
512 │ │ specified in their parent, │
513 │ │ with the exception of │
514 │ │ --ksmeta (templating) and │
515 │ │ --kopts (kernel options), │
516 │ │ which will be blended │
517 │ │ together. │
518 ├────────────────────┼────────────────────────────┤
519 │ │ Example: If profile A has │
520 │ │ --kopts="x=7 y=2", B │
521 │ │ inherits from A, and B has │
522 │ │ --kopts="x=9 z=2", the │
523 │ │ actual kernel options that │
524 │ │ will be used for B are x=9 │
525 │ │ y=2 z=2. │
526 └────────────────────┴────────────────────────────┘
527 │ │ 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 │
564 │ │ default 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
575 required to create system records in Cobbler, though they are useful
576 when system specific customizations are required. One such customiza‐
577 tion would be defining the MAC address. If there is a specific role
578 intended 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
582 automatic installation template used by Cobbler must contain certain
583 automatic 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 │
617│ │ behavior. │
618├───────────────────────────┼─────────────────────────────────────────────────────────────┤
619│ │ A system created with name │
620│ │ "default" has special │
621│ │ semantics. If a default │
622│ │ system object exists, it │
623│ │ sets all undefined systems │
624│ │ to PXE to a specific pro‐ │
625│ │ file. Without a "default" │
626│ │ system name created, PXE │
627│ │ will fall through to local │
628│ │ boot for unconfigured sys‐ │
629│ │ tems. │
630├───────────────────────────┼─────────────────────────────────────────────────────────────┤
631│ │ When using "default" name, │
632│ │ don't specify any other │
633│ │ arguments than --profile │
634│ │ ... they won't be used. │
635├───────────────────────────┼─────────────────────────────────────────────────────────────┤
636│mac │ Specifying a mac address │
637│ │ via --mac allows the sys‐ │
638│ │ tem object to boot │
639│ │ directly to a specific │
640│ │ profile via PXE, bypassing │
641│ │ Cobbler's PXE menu. If │
642│ │ the name of the Cobbler │
643│ │ system already looks like │
644│ │ a mac address, this is │
645│ │ inferred from the system │
646│ │ name and does not need to │
647│ │ be specified. │
648└───────────────────────────┴─────────────────────────────────────────────────────────────┘
649│ │ MAC addresses have the │
662│ │ format AA:BB:CC:DD:EE:FF. │
663│ │ It's highly recommended to │
664│ │ register your │
665│ │ MAC-addresses in Cobbler │
666│ │ if you're using static │
667│ │ addressing with multiple │
668│ │ interfaces, or if you are │
669│ │ using any of the advanced │
670│ │ networking features like │
671│ │ bonding, bridges or VLANs. │
672├───────────────────────────┼─────────────────────────────────────────────────────────────┤
673│ │ Cobbler does contain a │
674│ │ feature (enabled in │
675│ │ /etc/cobbler/settings) │
676│ │ that can automatically add │
677│ │ new system records when it │
678│ │ finds profiles being pro‐ │
679│ │ visioned on hardware it │
680│ │ has seen before. This may │
681│ │ help if you do not have a │
682│ │ report of all the MAC │
683│ │ addresses in your datacen‐ │
684│ │ ter/lab configuration. │
685├───────────────────────────┼─────────────────────────────────────────────────────────────┤
686│ip-address │ If Cobbler is configured │
687│ │ to generate a DHCP config‐ │
688│ │ uration (see advanced sec‐ │
689│ │ tion), use this setting to │
690│ │ define a specific IP for │
691│ │ this system in DHCP. │
692│ │ Leaving off this parameter │
693│ │ will result in no DHCP │
694│ │ management for this par‐ │
695│ │ ticular system. │
696├───────────────────────────┼─────────────────────────────────────────────────────────────┤
697│ │ Example: │
698│ │ --ip-address=192.168.1.50 │
699├───────────────────────────┼─────────────────────────────────────────────────────────────┤
700│ │ If DHCP management is dis‐ │
701│ │ abled and the interface is │
702│ │ labelled --static=1, this │
703│ │ setting will be used for │
704│ │ static IP configuration. │
705├───────────────────────────┼─────────────────────────────────────────────────────────────┤
706│ │ Special feature: To con‐ │
707│ │ trol the default PXE │
708│ │ behavior for an entire │
709│ │ subnet, this field can │
710│ │ also be passed in using │
711│ │ CIDR notation. If --ip is │
712│ │ CIDR, do not specify any │
713│ │ other arguments other than │
714│ │ --name and --profile. │
715├───────────────────────────┼─────────────────────────────────────────────────────────────┤
716│ │ When using the CIDR nota‐ │
717│ │ tion trick, don't specify │
718│ │ any arguments other than │
719│ │ --name and --profile... │
720│ │ they won't be used. │
721└───────────────────────────┴─────────────────────────────────────────────────────────────┘
722│dns-name │ If using the DNS manage‐ │
728│ │ ment feature (see advanced │
729│ │ section -- Cobbler sup‐ │
730│ │ ports auto-setup of BIND │
731│ │ and dnsmasq), use this to │
732│ │ define a hostname for the │
733│ │ system to receive from │
734│ │ DNS. │
735├───────────────────────────┼─────────────────────────────────────────────────────────────┤
736│ │ Example: --dns-name=mycom‐ │
737│ │ puter.example.com │
738├───────────────────────────┼─────────────────────────────────────────────────────────────┤
739│ │ This is a per-interface │
740│ │ parameter. If you have │
741│ │ multiple interfaces, it │
742│ │ may be different for each │
743│ │ interface, for example, │
744│ │ assume a DMZ / dual-homed │
745│ │ setup. │
746├───────────────────────────┼─────────────────────────────────────────────────────────────┤
747│gateway and netmask │ If you are using static IP │
748│ │ configurations and the │
749│ │ interface is flagged │
750│ │ --static=1, these will be │
751│ │ applied. │
752├───────────────────────────┼─────────────────────────────────────────────────────────────┤
753│ │ Netmask is a per-interface │
754│ │ parameter. Because of the │
755│ │ way gateway is stored on │
756│ │ the installed OS, gateway │
757│ │ is a global parameter. You │
758│ │ may use --static-routes │
759│ │ for per-interface cus‐ │
760│ │ tomizations if required. │
761├───────────────────────────┼─────────────────────────────────────────────────────────────┤
762│if-gateway │ If you are using static IP │
763│ │ configurations and have │
764│ │ multiple interfaces, use │
765│ │ this to define different │
766│ │ gateway for each inter‐ │
767│ │ face. │
768├───────────────────────────┼─────────────────────────────────────────────────────────────┤
769│ │ This is a per-interface │
770│ │ setting. │
771├───────────────────────────┼─────────────────────────────────────────────────────────────┤
772│hostname │ This field corresponds to │
773│ │ the hostname set in a sys‐ │
774│ │ tems /etc/sysconfig/net‐ │
775│ │ work file. This has no │
776│ │ bearing on DNS, even when │
777│ │ manage_dns is enabled. │
778│ │ Use --dns-name instead for │
779│ │ that feature. │
780├───────────────────────────┼─────────────────────────────────────────────────────────────┤
781│ │ This parameter is assigned │
782│ │ once per system, it is not │
783│ │ a per-interface setting. │
784└───────────────────────────┴─────────────────────────────────────────────────────────────┘
785│power-address, power-type, │ Cobbler contains features │
794│power-user, power-pass, │ that enable integration │
795│power-id │ with power management for │
796│ │ easier installation, rein‐ │
797│ │ stallation, and management │
798│ │ of machines in a datacen‐ │
799│ │ ter environment. These │
800│ │ parameters are described │
801│ │ online at power-manage‐ │
802│ │ ment. If you have a │
803│ │ power-managed datacen‐ │
804│ │ ter/lab setup, usage of │
805│ │ these features may be │
806│ │ something you are inter‐ │
807│ │ ested in. │
808├───────────────────────────┼─────────────────────────────────────────────────────────────┤
809│static │ Indicates that this inter‐ │
810│ │ face is statically config‐ │
811│ │ ured. Many fields (such │
812│ │ as gateway/netmask) will │
813│ │ not be used unless this │
814│ │ field is enabled. │
815├───────────────────────────┼─────────────────────────────────────────────────────────────┤
816│ │ This is a per-interface │
817│ │ setting. │
818├───────────────────────────┼─────────────────────────────────────────────────────────────┤
819│static-routes │ This is a space delimited │
820│ │ list of ip/mask:gateway │
821│ │ routing information in │
822│ │ that format. Most systems │
823│ │ will not need this infor‐ │
824│ │ mation. │
825├───────────────────────────┼─────────────────────────────────────────────────────────────┤
826│ │ This is a per-interface │
827│ │ setting. │
828├───────────────────────────┼─────────────────────────────────────────────────────────────┤
829│virt-bridge │ (Virt-only) While │
830│ │ --virt-bridge is present │
831│ │ in the profile object (see │
832│ │ above), here it works on │
833│ │ an interface by interface │
834│ │ basis. For instance it │
835│ │ would be possible to have │
836│ │ --virt-bridge0=xenbr0 and │
837│ │ --virt-bridge1=xenbr1. If │
838│ │ not specified in Cobbler │
839│ │ for each interface, Koan │
840│ │ will use the value as │
841│ │ specified in the profile │
842│ │ for each interface, which │
843│ │ may not always be what is │
844│ │ intended, but will be suf‐ │
845│ │ ficient in most cases. │
846├───────────────────────────┼─────────────────────────────────────────────────────────────┤
847│ │ This is a per-interface │
848│ │ setting. │
849└───────────────────────────┴─────────────────────────────────────────────────────────────┘
850│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 │
880│ │ required. If the auto‐ │
881│ │ matic installation file is │
882│ │ a 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 │
899│ │ enabled in /etc/cob‐ │
900│ │ bler/settings) that can │
901│ │ automatically trip off │
902│ │ this value after a system │
903│ │ gets done installing. This │
904│ │ can prevent installs from │
905│ │ appearing in an endless │
906│ │ loop when the system is │
907│ │ set to PXE first in the │
908│ │ BIOS order. │
909├───────────────────────────┼─────────────────────────────────────────────────────────────┤
910│repos-enabled │ If set true, Koan can │
911│ │ reconfigure repositories │
912│ │ after installation. This │
913│ │ is described further on │
914│ │ the 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 │
939│ │ $insert_cobbler_systems_def‐ │
940│ │ initions is found in the │
941│ │ DHCP template. However, you │
942│ │ may want certain systems to │
943│ │ expand out in other places │
944│ │ in the DHCP config file. │
945│ │ Setting --dhcp-tag=subnet2 │
946│ │ for instance, will cause │
947│ │ that system to expand out │
948│ │ where $insert_cobbler_sys‐ │
949│ │ tem_definitions_subnet2 is │
950│ │ found, allowing you to │
951│ │ insert directives to specify │
952│ │ different subnets (or other │
953│ │ parameters) before the DHCP │
954│ │ configuration entries for │
955│ │ those 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 │
995│ │ --ip-address=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 │
1037│ │ define 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 │
1049│ │ --interface=eth0 │
1050│ │ --mac=AA:BB:CC:DD:EE:00 --inter‐ │
1051│ │ face-type=bond_slave --inter‐ │
1052│ │ face-master=bond0 │
1053└───────────────────────────┴─────────────────────────────────────────────────────────────┘
1054│ │ cobbler system edit --name=foo │
1058│ │ --interface=eth1 │
1059│ │ --mac=AA:BB:CC:DD:EE:01 --inter‐ │
1060│ │ face-type=bond_slave --inter‐ │
1061│ │ face-master=bond0 │
1062├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1063│ │ cobbler system edit --name=foo │
1064│ │ --interface=bond0 --inter‐ │
1065│ │ face-type=bond --bond‐ │
1066│ │ ing-opts="mode=active-backup │
1067│ │ miimon=100" │
1068│ │ --ip-address=192.168.0.63 --net‐ │
1069│ │ mask=255.255.255.0 --gate‐ │
1070│ │ way=192.168.0.1 --static=1 │
1071├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1072│ │ More information about networking │
1073│ │ setup is available at │
1074│ │ https://github.com/cobbler/cobbler/wiki/Advanced-networking │
1075├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1076│ │ To review what networking configuration you have for any │
1077│ │ object, run "cobbler system report" at any time: │
1078├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1079│ │ Example: │
1080├───────────────────────────┼─────────────────────────────────────────────────────────────┤
1081│ │ cobbler system report --name=foo │
1082└───────────────────────────┴─────────────────────────────────────────────────────────────┘
1083 Cobbler repo
1085 Repository mirroring allows Cobbler to mirror not only install trees
1086 ("cobbler import" does this for you) but also optional packages, 3rd
1087 party content, and even updates. Mirroring all of this content locally
1088 on your network will result in faster, more up-to-date installations
1089 and faster updates. If you are only provisioning a home setup, this
1090 will probably be overkill, though it can be very useful for larger set‐
1091 ups (labs, datacenters, etc).
1092 $ 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]
1094 ┌─────────────────┬───────────────────────────────────────────────────┐
1096 │Name │ Description │
1097 ├─────────────────┼───────────────────────────────────────────────────┤
1098 │mirror │ The address of the yum │
1099 │ │ mirror. This can be an │
1100 │ │ rsync://-URL, an ssh loca‐ │
1101 │ │ tion, or a http:// or │
1102 │ │ ftp:// mirror location. │
1103 │ │ Filesystem paths also │
1104 │ │ work. │
1105 ├─────────────────┼───────────────────────────────────────────────────┤
1106 │ │ The mirror address should │
1107 │ │ specify an exact reposi‐ │
1108 │ │ tory to mirror -- just one │
1109 │ │ architecture and just one │
1110 │ │ distribution. If you have │
1111 │ │ a separate repo to mirror │
1112 │ │ for a different arch, add │
1113 │ │ that repo separately. │
1114 ├─────────────────┼───────────────────────────────────────────────────┤
1115 │ │ Here's an example of what │
1116 │ │ looks like a good URL: │
1117 └─────────────────┴───────────────────────────────────────────────────┘
1118 │ │ │
1124 │ │ · rsync://yourmir‐ │
1125 │ │ ror.exam‐ │
1126 │ │ ple.com/fedora-linux-core/updates/6/i386 │
1127 │ │ (for rsync proto‐ │
1128 │ │ col) │
1129 │ │ │
1130 │ │ · http://mir‐ │
1131 │ │ rors.ker‐ │
1132 │ │ nel.org/fedora/extras/6/i386/ │
1133 │ │ (for http) │
1134 │ │ │
1135 │ │ · user@yourmir‐ │
1136 │ │ ror.exam‐ │
1137 │ │ ple.com/fedora-linux-core/updates/6/i386 │
1138 │ │ (for SSH) │
1139 ├─────────────────┼───────────────────────────────────────────────────┤
1140 │ │ Experimental support is also provided for mirror‐ │
1141 │ │ ing RHN content when you need a fast local mir‐ │
1142 │ │ ror. The mirror syntax for this is --mir‐ │
1143 │ │ ror=rhn://channel-name and you must have entitle‐ │
1144 │ │ ments for this to work. This requires the Cobbler │
1145 │ │ server to be installed on RHEL 5 or later. You │
1146 │ │ will also need a version of yum-utils equal or │
1147 │ │ greater to 1.0.4. │
1148 ├─────────────────┼───────────────────────────────────────────────────┤
1149 │name │ This name is used as the save location for the │
1150 │ │ mirror. If the mirror represented, say, Fedora │
1151 │ │ Core 6 i386 updates, a good name would be │
1152 │ │ fc6i386updates. Again, be specific. │
1153 ├─────────────────┼───────────────────────────────────────────────────┤
1154 │ │ This name corresponds with values given to the │
1155 │ │ --repos parameter of cobbler profile add. If a │
1156 │ │ profile has a --repos-value that matches the name │
1157 │ │ given here, that repo can be automatically set up │
1158 │ │ during provisioning (when supported) and │
1159 │ │ installed systems will also use the boot server │
1160 │ │ as a mirror (unless yum_post_install_mirror is │
1161 │ │ disabled in the settings file). By default the │
1162 │ │ provisioning server will act as a mirror to sys‐ │
1163 │ │ tems it installs, which may not be desirable for │
1164 │ │ laptop configurations, etc. │
1165 ├─────────────────┼───────────────────────────────────────────────────┤
1166 │ │ Distros that can make use of yum repositories │
1167 │ │ during automatic installation include FC6 and │
1168 │ │ later, RHEL 5 and later, and derivative distribu‐ │
1169 │ │ tions. │
1170 ├─────────────────┼───────────────────────────────────────────────────┤
1171 │ │ See the documentation on cobbler profile add for │
1172 │ │ more information. │
1173 ├─────────────────┼───────────────────────────────────────────────────┤
1174 │rpm-list │ By specifying a space-delimited list of package │
1175 │ │ names for --rpm-list, one can decide to mirror │
1176 │ │ only a part of a repo (the list of packages │
1177 │ │ given, plus dependencies). This may be helpful in │
1178 │ │ conserving time/space/bandwidth. For instance, │
1179 │ │ when mirroring FC6 Extras, it may be desired to │
1180 │ │ mirror just Cobbler and Koan, and skip all of the │
1181 │ │ game packages. To do this, use --rpm-list="cob‐ │
1182 │ │ bler koan". │
1183 └─────────────────┴───────────────────────────────────────────────────┘
1184 │ │ This option only works for http:// and ftp:// │
1190 │ │ repositories (as it is powered by yumdownloader). │
1191 │ │ It will be ignored for other mirror types, such │
1192 │ │ as local paths and rsync:// mirrors. │
1193 ├─────────────────┼───────────────────────────────────────────────────┤
1194 │createrepo-flags │ Specifies optional flags to feed into the cre‐ │
1195 │ │ aterepo tool, which is called when cobbler │
1196 │ │ reposync is run for the given repository. The │
1197 │ │ defaults are -c cache. │
1198 ├─────────────────┼───────────────────────────────────────────────────┤
1199 │keep-updated │ Specifies that the named repository should not be │
1200 │ │ updated during a normal "cobbler reposync". The │
1201 │ │ repo may still be updated by name. The repo │
1202 │ │ should be synced at least once before disabling │
1203 │ │ this feature. See "cobbler reposync" below. │
1204 ├─────────────────┼───────────────────────────────────────────────────┤
1205 │mirror-locally │ When set to N, specifies that this yum repo is to │
1206 │ │ be referenced directly via automatic installation │
1207 │ │ files and not mirrored locally on the Cobbler │
1208 │ │ server. Only http:// and ftp:// mirror urls are │
1209 │ │ supported when using --mirror-locally=N, you can‐ │
1210 │ │ not use filesystem URLs. │
1211 ├─────────────────┼───────────────────────────────────────────────────┤
1212 │priority │ Specifies the priority of the repository (the │
1213 │ │ lower the number, the higher the priority), which │
1214 │ │ applies to installed machines using the reposito‐ │
1215 │ │ ries that also have the yum priorities plugin │
1216 │ │ installed. The default priority for the plugins │
1217 │ │ 99, as is that of all Cobbler mirrored reposito‐ │
1218 │ │ ries. │
1219 ├─────────────────┼───────────────────────────────────────────────────┤
1220 │arch │ Specifies what architecture the repository should │
1221 │ │ use. By default the current system arch (of the │
1222 │ │ server) is used,which may not be desirable. Using │
1223 │ │ this to override the default arch allows mirror‐ │
1224 │ │ ing of source repositories(using --arch=src). │
1225 ├─────────────────┼───────────────────────────────────────────────────┤
1226 │yumopts │ Sets values for additional yum options that the │
1227 │ │ repo should use on installed systems. For │
1228 │ │ instance if a yum plugin takes a certain parame‐ │
1229 │ │ ter "alpha" and "beta", use something like │
1230 │ │ --yumopts="alpha=2 beta=3". │
1231 ├─────────────────┼───────────────────────────────────────────────────┤
1232 │breed │ Ordinarily Cobbler's repo system will understand │
1233 │ │ what you mean without supplying this parameter, │
1234 │ │ though you can set it explicitly if needed. │
1235 └─────────────────┴───────────────────────────────────────────────────┘
1236 Cobbler image
1238 Example:
1239 $ cobbler image
1241 cobbler mgmtclass
1243 Management classes allows Cobbler to function as an configuration man‐
1244 agement system. Cobbler currently supports the following resource
1245 types:
1246 1. Packages
1248 2. Files
1250 Resources are executed in the order listed above.
1252 $ cobbler mgmtclass add --name=string --comment=string [--packages=list] [--files=list]
1254 ┌─────────┬────────────────────────────┐
1256 │Name │ Description │
1257 ├─────────┼────────────────────────────┤
1258 │name │ The name of the mgmtclass. │
1259 │ │ Use this name when adding │
1260 │ │ a management class to a │
1261 │ │ system, profile, or dis‐ │
1262 │ │ tro. To add a mgmtclass │
1263 │ │ to an existing system use │
1264 │ │ something like (cobbler │
1265 │ │ system edit --name="mad‐ │
1266 │ │ hatter" │
1267 │ │ --mgmt-classes="http │
1268 │ │ mysql"). │
1269 ├─────────┼────────────────────────────┤
1270 │comment │ A comment that describes │
1271 │ │ the functions of the man‐ │
1272 │ │ agement class. │
1273 ├─────────┼────────────────────────────┤
1274 │packages │ Specifies a list of pack‐ │
1275 │ │ age resources required by │
1276 │ │ the management class. │
1277 ├─────────┼────────────────────────────┤
1278 │files │ Specifies a list of file │
1279 │ │ resources required by the │
1280 │ │ management class. │
1281 └─────────┴────────────────────────────┘
1282 Cobbler package
1284 Package resources are managed using cobbler package add
1285 Actions:
1287 ┌──────────┬────────────────────────────┐
1289 │Name │ Description │
1290 ├──────────┼────────────────────────────┤
1291 │install │ Install the package. │
1292 │ │ [Default] │
1293 ├──────────┼────────────────────────────┤
1294 │uninstall │ Uninstall the package. │
1295 └──────────┴────────────────────────────┘
1296 Attributes:
1298 ┌──────────┬────────────────────────────┐
1300 │Name │ Description │
1301 ├──────────┼────────────────────────────┤
1302 │installer │ Which package manager to │
1303 │ │ use, vaild options │
1304 │ │ [rpm|yum]. │
1305 ├──────────┼────────────────────────────┤
1306 │version │ Which version of the pack‐ │
1307 │ │ age to install. │
1308 └──────────┴────────────────────────────┘
1309 Example:
1311 $ cobbler package add --name=string --comment=string [--action=install|uninstall] --installer=string [--version=string]
1313 Cobbler file
1315 Actions:
1316 ┌───────┬────────────────────────────┐
1318 │Name │ Description │
1319 └───────┴────────────────────────────┘
1320 │create │ Create the file. [Default] │
1322 ├───────┼────────────────────────────┤
1323 │remove │ Remove the file. │
1324 └───────┴────────────────────────────┘
1325 Attributes:
1327 ┌─────────┬────────────────────────────┐
1329 │Name │ Description │
1330 ├─────────┼────────────────────────────┤
1331 │mode │ Permission mode (as in │
1332 │ │ chmod). │
1333 ├─────────┼────────────────────────────┤
1334 │group │ The group owner of the │
1335 │ │ file. │
1336 ├─────────┼────────────────────────────┤
1337 │user │ The user for the file. │
1338 ├─────────┼────────────────────────────┤
1339 │path │ The path for the file. │
1340 ├─────────┼────────────────────────────┤
1341 │template │ The template for the file. │
1342 └─────────┴────────────────────────────┘
1343 Example:
1345 $ cobbler file add --name=string --comment=string [--action=string] --mode=string --group=string --owner=string --path=string [--template=string]
1347 cobbler aclsetup
1349 Example:
1350 $ cobbler aclsetup
1352 Cobbler buildiso
1354 Example:
1355 $ cobbler buildiso
1357 Cobbler import
1359 Example:
1360 $ cobbler import
1362 Cobbler list
1364 This list all the names grouped by type. Identically to cobbler report
1365 there are subcommands for most of the other Cobbler commands. (Cur‐
1366 rently: distro, profile, system, repo, image, mgmtclass, package, file)
1367 $ cobbler list
1369 Cobbler replicate
1371 Cobbler can replicate configurations from a master Cobbler server. Each
1372 Cobbler server is still expected to have a locally relevant /etc/cob‐
1373 bler/cobbler.conf and modules.conf, as these files are not synced.
1374 This feature is intended for load-balancing, disaster-recovery, backup,
1376 or multiple geography support.
1377 Cobbler can replicate data from a central server.
1379 Objects that need to be replicated should be specified with a pattern,
1381 such as --profiles="webservers* dbservers*" or --systems="*.exam‐
1382 ple.org". All objects matched by the pattern, and all dependencies of
1383 those objects matched by the pattern (recursively) will be transferred
1384 from the remote server to the central server. This is to say if you
1385 intend to transfer *.example.org and the definition of the systems have
1386 not changed, but a profile above them has changed, the changes to that
1387 profile will also be transferred.
1388 In the case where objects are more recent on the local server, those
1390 changes will not be overridden locally.
1391 Common data locations will be rsync'ed from the master server unless
1393 --omit-data is specified.
1394 To delete objects that are no longer present on the master server, use
1396 --prune.
1397 Warning: This will delete all object types not present on the remote
1399 server from the local server, and is recursive. If you use prune, it
1400 is best to manage Cobbler centrally and not expect changes made on the
1401 slave servers to be preserved. It is not currently possible to just
1402 prune objects of a specific type.
1403 Example:
1405 $ cobbler replicate --master=cobbler.example.org [--distros=pattern] [--profiles=pattern] [--systems=pattern] [--repos-pattern] [--images=pattern] [--prune] [--omit-data]
1407 Cobbler report
1409 This lists all configuration which Cobbler can obtain from the saved
1410 data. There are also report subcommands for most of the other Cobbler
1411 commands (currently: distro, profile, system, repo, image, mgmtclass,
1412 package, file).
1413 $ cobbler report --name=[object-name]
1415 --name=[object-name]
1417 Optional parameter which filters for object with the given name.
1419 Cobbler reposync
1421 Example:
1422 $ cobbler reposync
1424 Cobbler sync
1426 The sync command is very important, though very often unnecessary for
1427 most situations. It's primary purpose is to force a rewrite of all con‐
1428 figuration files, distribution files in the TFTP root, and to restart
1429 managed services. So why is it unnecessary? Because in most common sit‐
1430 uations (after an object is edited, for example), Cobbler executes what
1431 is known as a "lite sync" which rewrites most critical files.
1432 When is a full sync required? When you are using manage_dhcpd (Managing
1434 DHCP) with systems that use static leases. In that case, a full sync
1435 is required to rewrite the dhcpd.conf file and to restart the dhcpd
1436 service.
1437 Cobbler sync is used to repair or rebuild the contents /tftpboot or
1439 /var/www/cobbler when something has changed behind the scenes. It
1440 brings the filesystem up to date with the configuration as understood
1441 by Cobbler.
1442 Sync should be run whenever files in /var/lib/cobbler are manually
1444 edited (which is not recommended except for the settings file) or when
1445 making changes to automatic installation files. In practice, this
1446 should not happen often, though running sync too many times does not
1447 cause any adverse effects.
1448 If using Cobbler to manage a DHCP and/or DNS server (see the advanced
1450 section of this manpage), sync does need to be run after systems are
1451 added to regenerate and reload the DHCP/DNS configurations.
1452 The sync process can also be kicked off from the web interface.
1454 Example:
1456 $ cobbler sync
1458 Cobbler validate-autoinstalls
1460 Example:
1461 $ cobbler validate-autoinstalls
1463 Cobbler version
1465 Example:
1466 $ cobbler version
1468 Cobbler signature
1470 Example:
1471 $ cobbler signature
1473 Cobbler get-loaders
1475 Example:
1476 $ cobbler get-loaders
1478 Cobbler hardlink
1480 Example:
1481 $ cobbler hardlink
1483
1485 Cobbler's command line returns a zero for success and non-zero for
1486 failure.
1487
1489 We have a Gitter Channel and you also can ask questions as GitHub
1490 issues. The IRC Channel on Freenode (#cobbler) is not that active but
1491 sometimes there are people who can help you.
1492 The way we would prefer are GitHub issues as they are easily search‐
1494 able.
1495
1497 Jörgen Maas
1498
1500 2020, Enno Gotthold
15013.2 Oct 25, 2020 COBBLER(1)