cobbler - Man Page

Name

cobbler — Cobbler CLI Documentation

This page contains a description for commands which can be used from the CLI.

General Principles

This should just be a brief overview. For the detailed expanations please reefer to Readthedocs.

Distros, Profiles and Systems

Cobbler has a system of inheritance when it comes to managing the information you want to apply to a certain system.

Images

Repositorys

Management Classes

Deleting configuration entries

If you want to remove a specific object, use the remove command with the name that was used to add it.

    cobbler distro|profile|system|repo|image|mgmtclass|package|file remove --name=string

Editing

If you want to change a particular setting without doing an add again, use the edit command, using the same name you gave when you added the item. Anything supplied in the parameter list will overwrite the settings in the existing object, preserving settings not mentioned.

cobbler distro|profile|system|repo|image|mgmtclass|package|file edit --name=string [parameterlist]

Copying

Objects can also be copied:

cobbler distro|profile|system|repo|image|mgmtclass|package|file copy --name=oldname --newname=newname

Renaming

Objects can also be renamed, as long as other objects don't reference them.

cobbler distro|profile|system|repo|image|mgmtclass|package|file rename --name=oldname --newname=newname

CLI-Commands

Short Usage: cobbler command [subcommand] [--arg1=value1] [--arg2=value2]

Long Usage:

cobbler <distro|profile|system|repo|image|mgmtclass|package|file> ... [add|edit|copy|get-autoinstall*|list|remove|rename|report] [options|--help]
cobbler <aclsetup|buildiso|import|list|replicate|report|reposync|sync|validate-autoinstalls|version|signature|get-loaders|hardlink> [options|--help]

cobbler distro

This first step towards configuring what you want to install is to add a distribution record to cobbler's configuration.

If there is an rsync mirror, DVD, NFS, or filesystem tree available that you would rather import instead, skip down to the documentation about the import command. It's really a lot easier to follow the import workflow -- it only requires waiting for the mirror content to be copied and/or scanned. Imported mirrors also save time during install since they don't have to hit external install sources.

If you want to be explicit with distribution definition, however, here's how it works:

$ 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]
NameDescription
namea string identifying the distribution, this should be something like rhel6.
kernelAn absolute filesystem path to a kernel image.
initrdAn absolute filesystem path to a initrd image.
koptsSets kernel command-line arguments that the distro, and profiles/systems depending on it, will use. To remove a kernel argument that may be added by a higher cobbler object (or in the global settings), you can prefix it with a !.
Example: --kopts="foo=bar baz=3 asdf !gulp"
This example passes the arguments foo=bar baz=3 asdf but will make sure gulp is not passed even if it was requested at a level higher up in the cobbler configuration.
kopts-postThis is just like --kopts, though it governs kernel options on the installed OS, as opposed to kernel options fed to the installer. The syntax is exactly the same. This requires some special snippets to be found in your automatic installation template in order for this to work. Automatic installation templating is described later on in this document.
Example: noapic
archSets the architecture for the PXE bootloader and also controls how koan's --replace-self option will operate.
The default setting (standard) will use pxelinux. Set to ppc and ppc64 to use yaboot.
x86 and x86_64 effectively do the same thing as standard.
If you perform a cobbler import, the arch field will be auto-assigned.
ksmetaThis is an advanced feature that sets automatic installation template variables to substitute, thus enabling those files to be treated as templates. Templates are powered using Cheetah and are described further along in this manpage as well as on the Cobbler Wiki.
Example: --ksmeta="foo=bar baz=3 asdf"
See the section on "Kickstart Templating" for further information.
breedControls how various physical and virtual parameters, including kernel arguments for automatic installation, are to be treated. Defaults to redhat, which is a suitable value for Fedora and CentOS as well. It means anything redhat based.
There is limited experimental support for specifying "debian", "ubuntu", or "suse", which treats the automatic installation template file as a preseed/autoyast file format and changes the kernel arguments appropriately. Support for other types of distributions is possible in the future. See the Wiki for the latest information about support for these distributions.
The file used for the answer file, regardless of the breed setting, is the value used for --autoinst when creating the profile.
os-versionGenerally this field can be ignored. It is intended to alter some hardware setup for virtualized instances when provisioning guests with koan. The valid options for --os-version vary depending on what is specified for --breed. If you specify an invalid option, the error message will contain a list of valid os versions that can be used. If you don't know the os version or it does not appear in the list, omitting this argument or using other should be perfectly fine. If you don't encounter any problems with virtualized instances, this option can be safely ignored.
ownersUsers with small sites and a limited number of admins can probably ignore this option.  All cobbler objects (distros, profiles, systems, and repos) can take a --owners parameter to specify what cobbler users can edit particular objects.This only applies to the Cobbler WebUI and XMLRPC interface, not the "cobbler" command line tool run from the shell. Furthermore, this is only respected by the authz_ownership module which must be enabled in /etc/cobbler/modules.conf. The value for --owners is a space separated list of users and groups as specified in /etc/cobbler/users.conf. For more information see the users.conf file as well as the Cobbler Wiki. In the default Cobbler configuration, this value is completely ignored, as is users.conf.
template-filesThis feature allows cobbler to be used as a configuration management system. The argument is a space delimited string of key=value pairs. Each key is the path to a template file, each value is the path to install the file on the system. This is described in further detail on the Cobbler Wiki and is implemented using special code in the post install. Koan alsocan retrieve these files from a cobbler server on demand, effectively allowing cobbler to function as a lightweight templated configuration management system.

cobbler profile

A profile associates a distribution to additional specialized options, such as a installation automation file. Profiles are the core unit of provisioning and at least one profile must exist for every distribution to be provisioned. A profile might represent, for instance, a web server or desktop configuration. In this way, profiles define a role to be performed.

$ 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]

Arguments are the same as listed for distributions, save for the removal of "arch" and "breed", and with the additions listed below:

NameDescription
nameA descriptive name. This could be something like rhel5webservers or f9desktops.
distroThe name of a previously defined cobbler distribution. This value is required.
autoinstLocal filesystem path to a automatic installation file, the file must reside under /var/lib/cobbler/autoinstall_templates
name-serversIf your nameservers are not provided by DHCP, you can specify a space separated list of addresses here to configure each of the installed nodes to use them (provided the automatic installation files used are installed on a per-system basis). Users with DHCP setups should not need to use this option. This is available to set in profiles to avoid having to set it repeatedly for each system record.
name-servers-searchYou can specify a space separated list of domain names to configure each of the installed nodes to use them as domain search path.  This is available to set in profiles to avoid having to set it repeatedly for each system record.
virt-file-size(Virt-only) How large the disk image should be in Gigabytes. The default is 5. This can be a comma separated list (ex: 5,6,7) to allow for multiple disks of different sizes depending on what is given to --virt-path. This should be input as a integer or decimal value without units.
virt-ram(Virt-only) How many megabytes of RAM to consume. The default is 512 MB. This should be input as an integer without units.
virt-type(Virt-only) Koan can install images using either Xen paravirt (xenpv) or QEMU/KVM (qemu). Choose one or the other strings to specify, or values will default to attempting to find a compatible installation type on the client system("auto"). See the "koan" manpage for more documentation. The default --virt-type can be configured in the cobbler settings file such that this parameter does not have to be provided. Other virtualization types are supported, for information on those options (such as VMware), see the Cobbler Wiki.
virt-cpus(Virt-only) How many virtual CPUs should koan give the virtual machine? The default is 1. This is an integer.
virt-path(Virt-only) Where to store the virtual image on the host system. Except for advanced cases, this parameter can usually be omitted. For disk images, the value is usually an absolute path to an existing directory with an optional filename component. There is support for specifying partitions /dev/sda4 or volume groups VolGroup00, etc.
For multiple disks, separate the values with commas such as VolGroup00,VolGroup00 or /dev/sda4,/dev/sda5. Both those examples would create two disks for the VM.
virt-bridge(Virt-only) This specifies the default bridge to use for all systems defined under this profile. If not specified, itwill assume the default value in the cobbler settings file, which as shipped in the RPM is xenbr0. If using KVM, this is most likely not correct. You may want to override this setting in the system object. Bridge settings are important as they define how outside networking will reach the guest. For more information on bridge setup, see the Cobbler Wiki, where there is a section describing koan usage.
reposThis is a space delimited list of all the repos (created with cobbler repo add and updated with cobbler reposync)that this profile can make use of during automated installation. For example, an example might be --repos="fc6i386updates fc6i386extras" if the profile wants to access these two mirrors that are already mirrored on the cobbler server. Repo management is described in greater depth later in the manpage.
parentThis is an advanced feature.
Profiles may inherit from other profiles in lieu of specifying --distro. Inherited profiles will override any settings specified in their parent, with the exception of --ksmeta (templating) and --kopts (kernel options), which will be blended together.
Example: If profile A has --kopts="x=7 y=2", B inherits from A, and B has --kopts="x=9 z=2", the actual kernel options that will be used for B are x=9 y=2 z=2.
Example: If profile B has --virt-ram=256 and A has --virt-ram=512, profile B will use the value 256.
Example: If profile A has a --virt-file-size=5 and B does not specify a size, B will use the value from A.
serverThis parameter should be useful only in select circumstances. If machines are on a subnet that cannot access the cobbler server using the name/IP as configured in the cobbler settings file, use this parameter to override that servername. See also --dhcp-tag for configuring the next server and DHCP information of the system if you are also usingCobbler to help manage your DHCP configuration.

cobbler system

System records map a piece of hardware (or a virtual machine) with the cobbler profile to be assigned to run on it. This may be thought of as choosing a role for a specific system.

Note that if provisioning via koan and PXE menus alone, it is not required to create system records in cobbler, though they are useful when system specific customizations are required. One such customization would be defining the MAC address. If there is a specific role intended for a given machine, system records should be created for it.

System commands have a wider variety of control offered over network details. In order to use these to the fullest possible extent, the automatic installation template used by cobbler must contain certain automatic installation snippets (sections of code specifically written for Cobbler to make these values become reality). Compare your automatic installation templates with the stock ones in /var/lib/cobbler/autoinstall_templates if you have upgraded, to make sure you can take advantage of all options to their fullest potential. If you are a new cobbler user, base your automatic installation templates off of these templates.

Read more about networking setup at: https://github.com/cobbler/cobbler/wiki/Advanced-networking

Example:

$ 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]

Adds a cobbler System to the configuration. Arguments are specified as per "profile add" with the following changes:

NameDescription
nameThe system name works like the name option for other commands.
If the name looks like a MAC address or an IP, the name will implicitly be used for either --mac or --ip of the firstinterface, respectively. However, it's usually better to give a descriptive name -- don't rely on this behavior.
A system created with name "default" has special semantics. If a default system object exists, it sets all undefinedsystems to PXE to a specific profile.  Without a "default" system name created, PXE will fall through to local boot forunconfigured systems.
When using "default" name, don't specify any other arguments than --profile ... they won't be used.
macSpecifying a mac address via --mac allows the system object to boot directly to a specific profile via PXE, bypassingcobbler's PXE menu.  If the name of the cobbler system already looks like a mac address, this is inferred from thesystem name and does not need to be specified.
MAC addresses have the format AA:BB:CC:DD:EE:FF. It's highly recommended to register your MAC-addresses in Cobbler ifyou're using static addressing with multiple interfaces, or if you are using any of the advanced networking featureslike bonding, bridges or VLANs.
Cobbler does contain a feature (enabled in /etc/cobbler/settings) that can automatically add new system records when itfinds profiles being provisioned on hardware it has seen before.  This may help if you do not have a report of all theMAC addresses in your datacenter/lab configuration.
ip-addressIf cobbler is configured to generate a DHCP configuration (see advanced section), use this setting to define a specificIP for this system in DHCP.  Leaving off this parameter will result in no DHCP management for this particular system.
Example: --ip-address=192.168.1.50
If DHCP management is disabled and the interface is labelled --static=1, this setting will be used for static IPconfiguration.
Special feature: To control the default PXE behavior for an entire subnet, this field can also be passed in using CIDRnotation.  If --ip is CIDR, do not specify any other arguments other than --name and --profile.
When using the CIDR notation trick, don't specify any arguments other than --name and --profile... they won't be used.
dns-nameIf using the DNS management feature (see advanced section -- cobbler supports auto-setup of BIND and dnsmasq), use thisto define a hostname for the system to receive from DNS.
Example: --dns-name=mycomputer.example.com
This is a per-interface parameter.  If you have multiple interfaces, it may be different for each interface, forexample, assume a DMZ / dual-homed setup.
gateway and netmaskIf you are using static IP configurations and the interface is flagged --static=1, these will be applied.
Netmask is a per-interface parameter. Because of the way gateway is stored on the installed OS, gateway is a globalparameter. You may use --static-routes for per-interface customizations if required.
if-gatewayIf you are using static IP configurations and have multiple interfaces, use this to define different gateway for eachinterface.
This is a per-interface setting.
hostnameThis field corresponds to the hostname set in a systems /etc/sysconfig/network file.  This has no bearing on DNS, evenwhen manage_dns is enabled.  Use --dns-name instead for that feature.
This parameter is assigned once per system, it is not a per-interface setting.
power-address, power-type, power-user, power-pass, power-idCobbler contains features that enable integration with power management for easier installation, reinstallation, andmanagement of machines in a datacenter environment.  These parameters are described online athttps://github.com/cobbler/cobbler/wiki/Power-management. If you have a power-managed datacenter/lab setup, usage ofthese features may be something you are interested in.
staticIndicates that this interface is statically configured.  Many fields (such as gateway/netmask) will not be used unlessthis field is enabled.
This is a per-interface setting.
static-routesThis is a space delimited list of ip/mask:gateway routing information in that format. Most systems will not need thisinformation.
This is a per-interface setting.
virt-bridge(Virt-only) While --virt-bridge is present in the profile object (see above), here it works on an interface by interfacebasis. For instance it would be possible to have --virt-bridge0=xenbr0 and --virt-bridge1=xenbr1. If not specified incobbler for each interface, koan will use the value as specified in the profile for each interface, which may not alwaysbe what is intended, but will be sufficient in most cases.
This is a per-interface setting.
autoinstWhile it is recommended that the --autoinst parameter is only used within for the "profile add" command, there arelimited scenarios when an install base switching to cobbler may have legacy automatic installation files created on aper-system basis (one automatic installation file for each system, nothing shared) and may not want to immediately makeuse of the cobbler templating system. This allows specifying a automatic installation file for use on a per-systembasis. Creation of a parent profile is still required.  If the automatic installation file is a filesystem location, itwill still be treated as a cobbler template.
netboot-enabledIf set false, the system will be provisionable through koan but not through standard PXE. This will allow the system tofall back to default PXE boot behavior without deleting the cobbler system object. The default value allows PXE. Cobblercontains a PXE boot loop prevention feature (pxe_just_once, can be enabled in /etc/cobbler/settings) that canautomatically trip off this value after a system gets done installing. This can prevent installs from appearing in anendless loop when the system is set to PXE first in the BIOS order.
repos-enabledIf set true, koan can reconfigure repositories after installation. This is described further on the Cobbler Wiki,https://github.com/cobbler/cobbler/wiki/Manage-yum-repos.
dhcp-tagIf you are setting up a PXE environment with multiple subnets/gateways, and are using cobbler to manage a DHCPconfiguration, you will probably want to use this option. If not, it can be ignored.
By default, the dhcp tag for all systems is "default" and means that in the DHCP template files the systems will expandout where $insert_cobbler_systems_definitions is found in the DHCP template. However, you may want certain systems toexpand out in other places in the DHCP config file.  Setting --dhcp-tag=subnet2 for instance, will cause that system toexpand out where $insert_cobbler_system_definitions_subnet2 is found, allowing you to insert directives to specifydifferent subnets (or other parameters) before the DHCP configuration entries for those particular systems.
This is described further on the Cobbler Wiki.
interfaceBy default flags like --ip, --mac, --dhcp-tag, --dns-name, --netmask, --virt-bridge, and --static-routes operate on thefirst network interface defined for a system (eth0). However, cobbler supports an arbitrary number of interfaces. Using--interface=eth1 for instance, will allow creating and editing of a second interface.
Interface naming notes:
Additional interfaces can be specified (for example: eth1, or any name you like, as long as it does not conflict withany reserved names such as kernel module names) for use with the edit command. Defining VLANs this way is alsosupported, of you want to add VLAN 5 on interface eth0, simply name your interface eth0.5.
Example:
cobbler system edit --name=foo --ip-address=192.168.1.50 --mac=AA:BB:CC:DD:EE:A0
cobbler system edit --name=foo --interface=eth0 --ip-address=192.168.1.51 --mac=AA:BB:CC:DD:EE:A1
cobbler system report foo
Interfaces can be deleted using the --delete-interface option.
Example:
cobbler system edit --name=foo --interface=eth2 --delete-interface
interface-type, interface-master and bonding-opts/bridge-optsOne of the other advanced networking features supported by Cobbler is NIC bonding, bridging, and BMC. You can use thisto bond multiple physical network interfaces to one single logical interface to reduce single points of failure in yournetwork, to create bridged interfaces for things like tunnels and virtual machine networks, or to manage BMC interfaceby DHCP. Supported values for the --interface-type parameter are "bond", "bond_slave", "bridge", "bridge_slave","bonded_bridge_slave" and "bmc".  If one of the "_slave" options is specified, you also need to define themaster-interface for this bond using --interface-master=INTERFACE. Bonding and bridge options for the master-interfacemay be specified using --bonding-opts="foo=1 bar=2" or --bridge-opts="foo=1 bar=2", respectively.
Example:
cobbler system edit --name=foo --interface=eth0 --mac=AA:BB:CC:DD:EE:00 --interface-type=bond_slave --interface-master=bond0
cobbler system edit --name=foo --interface=eth1 --mac=AA:BB:CC:DD:EE:01 --interface-type=bond_slave --interface-master=bond0
cobbler system edit --name=foo --interface=bond0 --interface-type=bond --bonding-opts="mode=active-backup miimon=100" --ip-address=192.168.0.63 --netmask=255.255.255.0 --gateway=192.168.0.1 --static=1
More information about networking setup is available at https://github.com/cobbler/cobbler/wiki/Advanced-networking
To review what networking configuration you have for any object, run "cobbler system report" at any time:
Example:
cobbler system report --name=foo

cobbler repo

Repository mirroring allows cobbler to mirror not only install trees ("cobbler import" does this for you) but also optional packages, 3rd party content, and even updates. Mirroring all of this content locally on your network will result in faster, more up-to-date installations and faster updates. If you are only provisioning a home setup, this will probably be overkill, though it can be very useful for larger setups (labs, datacenters, etc).

$ 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]
NameDescription
mirrorThe address of the yum mirror. This can be an rsync://-URL, an ssh location, or a http:// or ftp:// mirror location. Filesystem paths also work.
The mirror address should specify an exact repository to mirror -- just one architecture and just one distribution. If you have a separate repo to mirror for a different arch, add that repo separately.
Here's an example of what looks like a good URL:
Experimental support is also provided for mirroring RHN content when you need a fast local mirror. The mirror syntax for this is --mirror=rhn://channel-name and you must have entitlements for this to work. This requires the cobbler server to be installed on RHEL5 or later. You will also need a version of yum-utils equal or greater to 1.0.4.
nameThis name is used as the save location for the mirror. If the mirror represented, say, Fedora Core 6 i386 updates, a good name would be fc6i386updates. Again, be specific.
This name corresponds with values given to the --repos parameter of cobbler profile add. If a profile has a --repos-value that matches the name given here, that repo can be automatically set up during provisioning (when supported) and installed systems will also use the boot server as a mirror (unless yum_post_install_mirror is disabled in the settings file). By default the provisioning server will act as a mirror to systems it installs, which may not be desirable for laptop configurations, etc.
Distros that can make use of yum repositories during automatic installation include FC6 and later, RHEL 5 and later, and derivative distributions.
See the documentation on cobbler profile add for more information.
rpm-listBy specifying a space-delimited list of package names for --rpm-list, one can decide to mirror only a part of a repo (the list of packages given, plus dependencies). This may be helpful in conserving time/space/bandwidth. For instance, when mirroring FC6 Extras, it may be desired to mirror just cobbler and koan, and skip all of the game packages. To do this, use --rpm-list="cobbler koan".
This option only works for http:// and ftp:// repositories (as it is powered by yumdownloader). It will be ignored for other mirror types, such as local paths and rsync:// mirrors.
createrepo-flagsSpecifies optional flags to feed into the createrepo tool, which is called when cobbler reposync is run for the given repository. The defaults are -c cache.
keep-updatedSpecifies that the named repository should not be updated during a normal "cobbler reposync". The repo may still beupdated by name. The repo should be synced at least once before disabling this feature. See "cobbler reposync" below.
mirror-locallyWhen set to N, specifies that this yum repo is to be referenced directly via automatic installation files and not mirrored locally on the cobbler server. Only http:// and ftp:// mirror urls are supported when using --mirror-locally=N, you cannot use filesystem URLs.
prioritySpecifies the priority of the repository (the lower the number, the higher the priority), which applies to installed machines using the repositories that also have the yum priorities plugin installed. The default priority for the plugins 99, as is that of all cobbler mirrored repositories.
archSpecifies what architecture the repository should use. By default the current system arch (of the server) is used,which may not be desirable. Using this to override the default arch allows mirroring of source repositories(using --arch=src).
yumoptsSets values for additional yum options that the repo should use on installed systems. For instance if a yum plugin takes a certain parameter "alpha" and "beta", use something like --yumopts="alpha=2 beta=3".
breedOrdinarily cobbler's repo system will understand what you mean without supplying this parameter, though you can set it explicitly if needed.

cobbler image

Example:

$ cobbler image

cobbler mgmtclass

Management classes allows cobbler to function as an configuration management system. Cobbler currently supports the following resource types:

  1. Packages
  2. Files

Resources are executed in the order listed above.

$ cobbler mgmtclass add --name=string --comment=string [--packages=list] [--files=list]
NameDescription
nameThe name of the mgmtclass. Use this name when adding a management class to a system, profile, or distro. To add amgmtclass to an existing system use something like (cobbler system edit --name="madhatter" --mgmt-classes="http mysql").
commentA comment that describes the functions of the management class.
packagesSpecifies a list of package resources required by the management class.
filesSpecifies a list of file resources required by the management class.

cobbler package

Package resources are managed using cobbler package add

Actions:

NameDescription
installInstall the package. [Default]
uninstallUninstall the package.

Attributes:

NameDescription
installerWhich package manager to use, vaild options [rpm|yum].
versionWhich version of the package to install.

Example:

$ cobbler package add --name=string --comment=string [--action=install|uninstall] --installer=string [--version=string]

cobbler file

Actions:

NameDescription
createCreate the file. [Default]
removeRemove the file.

Attributes:

NameDescription
modePermission mode (as in chmod).
groupThe group owner of the file.
userThe user for the file.
pathThe path for the file.
templateThe template for the file.

Example:

$ cobbler file add --name=string --comment=string [--action=string] --mode=string --group=string --owner=string --path=string [--template=string]

cobbler aclsetup

Example:

$ cobbler aclsetup

cobbler buildiso

Example:

$ cobbler buildiso

cobbler import

Example:

$ cobbler import

cobbler list

This list all the names grouped by type. Identically to cobbler report there are subcommands for most of the other cobbler commands. (Currently: distro, profile, system, repo, image, mgmtclass, package, file)

$ cobbler list

cobbler replicate

Cobbler can replicate configurations from a master cobbler server. Each cobbler server is still expected to have a locally relevant /etc/cobbler/cobbler.conf and modules.conf, as these files are not synced.

This feature is intended for load-balancing, disaster-recovery, backup, or multiple geography support.

Cobbler can replicate data from a central server.

Objects that need to be replicated should be specified with a pattern, such as --profiles="webservers* dbservers*" or --systems="*.example.org". All objects matched by the pattern, and all dependencies of those objects matched by the pattern (recursively) will be transferred from the remote server to the central server. This is to say if you intend to transfer *.example.org and the definition of the systems have not changed, but a profile above them has changed, the changes to that profile will also be transferred.

In the case where objects are more recent on the local server, those changes will not be overridden locally.

Common data locations will be rsync'ed from the master server unless --omit-data is specified.

To delete objects that are no longer present on the master server, use --prune.

Warning: This will delete all object types not present on the remote server from the local server, and is recursive. If you use prune, it is best to manage cobbler centrally and not expect changes made on the slave servers to be preserved. It is not currently possible to just prune objects of a specific type.

Example:

$ cobbler replicate --master=cobbler.example.org [--distros=pattern] [--profiles=pattern] [--systems=pattern] [--repos-pattern] [--images=pattern] [--prune] [--omit-data]

cobbler report

This lists all configuration which cobbler can obtain from the saved data. There are also report subcommands for most of the other cobbler commands. (Currently: distro, profile, system, repo, image, mgmtclass, package, file)

$ cobbler report --name=[object-name]

--name=[object-name]

Optional parameter which filters for object with the given name.

cobbler reposync

Example:

$ cobbler reposync

cobbler sync

The sync command is very important, though very often unnecessary for most situations. It's primary purpose is to force a rewrite of all configuration files, distribution files in the TFTP root, and to restart managed services. So why is it unnecessary? Because in most common situations (after an object is edited, for example), Cobbler executes what is known as a "lite sync" which rewrites most critical files.

When is a full sync required? When you are using manage_dhcpd (Managing DHCP) with systems that use static leases. In that case, a full sync is required to rewrite the dhcpd.conf file and to restart the dhcpd service.

Cobbler sync is used to repair or rebuild the contents /tftpboot or /var/www/cobbler when something has changed behind the scenes. It brings the filesystem up to date with the configuration as understood by cobbler.

Sync should be run whenever files in /var/lib/cobbler are manually edited (which is not recommended except for the settings file) or when making changes to automatic installation files. In practice, this should not happen often, though running sync too many times does not cause any adverse effects.

If using cobbler to manage a DHCP and/or DNS server (see the advanced section of this manpage), sync does need to be run after systems are added to regenerate and reload the DHCP/DNS configurations.

The sync process can also be kicked off from the web interface.

Example:

$ cobbler sync

cobbler validate-autoinstalls

Example:

$ cobbler validate-autoinstalls

cobbler version

Example:

$ cobbler version

cobbler signature

Example:

$ cobbler signature

cobbler get-loaders

Example:

$ cobbler get-loaders

Exit_status

cobbler's command line returns a zero for success and non-zero for failure.

Additional Help

We have a Gitter Channel and you also can ask questions as Github-Issues. The IRC Channel on Freenode (#cobbler) is not that active but sometimes there are people who can help you.

The way we would prefer are Github-Issues as they are easily searchable.

Author

Jörgen Maas

Info

May 26, 2020 3.0 Cobbler