3. General

This section of the manual covers the basic functions of cobbler, which most people will use.

• 3.1. Primitives
  • 3.1.1. Standard Rules
    • 3.1.1.1. Inheritance of Values
    • 3.1.1.2. Array Fields
    • 3.1.1.3. Hash Fields (key=value)
      • 3.1.1.3.1. Preserving Values When Editing
      • 3.1.1.3.2. Removing Values
      • 3.1.1.3.3. Suppressing Values
      • 3.1.1.3.4. Keys Without Values
      • 3.1.1.3.5. Keys With Multiple Values
  • 3.1.2. Standard Primitive Sub-commands
    • 3.1.2.1. List
    • 3.1.2.2. Report
    • 3.1.2.3. Remove
    • 3.1.2.4. Copy/Rename
    • 3.1.2.5. Find
    • 3.1.2.6. Dumpvars (Debugging)
  • 3.1.3. Cobbler Objects
    • 3.1.3.1. Distros
      • 3.1.3.1.1. Add/Edit Options
        • 3.1.3.1.1.1. –name (required)
        • 3.1.3.1.1.2. –kernel (required)
        • 3.1.3.1.1.3. –initrd (required)
        • 3.1.3.1.1.4. –arch
        • 3.1.3.1.1.5. –boot-files
        • 3.1.3.1.1.6. –breed
        • 3.1.3.1.1.7. –clobber
        • 3.1.3.1.1.8. –comment
        • 3.1.3.1.1.9. –fetchable-files
        • 3.1.3.1.1.10. –in-place
        • 3.1.3.1.1.11. –kopts
        • 3.1.3.1.1.12. –kopts-post
        • 3.1.3.1.1.13. –ksmeta
        • 3.1.3.1.1.14. –mgmt-classes
        • 3.1.3.1.1.15. –os-version
        • 3.1.3.1.1.16. –owners
        • 3.1.3.1.1.17. –redhat-management-key
        • 3.1.3.1.1.18. –redhat-management-server
        • 3.1.3.1.1.19. –template-files
    • 3.1.3.2. Profiles and Sub Profiles
      • 3.1.3.2.1. Add/Edit Options
        • 3.1.3.2.1.1. –name (required)
        • 3.1.3.2.1.2. –distro (required)
        • 3.1.3.2.1.3. –boot-files
        • 3.1.3.2.1.4. –clobber
        • 3.1.3.2.1.5. –comment
        • 3.1.3.2.1.6. –dhcp-tag
        • 3.1.3.2.1.7. –enable-gpxe
        • 3.1.3.2.1.8. –enable-menu
        • 3.1.3.2.1.9. –fetchable-files
        • 3.1.3.2.1.10. –in-place
        • 3.1.3.2.1.11. –kickstart
        • 3.1.3.2.1.12. –kopts
        • 3.1.3.2.1.13. –kopts-post
        • 3.1.3.2.1.14. –ksmeta
        • 3.1.3.2.1.15. –mgmt-classes, –mgmt-parameters
        • 3.1.3.2.1.16. –name-servers
        • 3.1.3.2.1.17. –name-servers-search
        • 3.1.3.2.1.18. –owners
        • 3.1.3.2.1.19. –parent
        • 3.1.3.2.1.20. –proxy
        • 3.1.3.2.1.21. –redhat-management-key
        • 3.1.3.2.1.22. –redhat-management-server
        • 3.1.3.2.1.23. –repos
        • 3.1.3.2.1.24. –server
        • 3.1.3.2.1.25. –template-files
        • 3.1.3.2.1.26. –template-remote-kickstarts
        • 3.1.3.2.1.27. –virt-auto-boot
        • 3.1.3.2.1.28. –virt-bridge
        • 3.1.3.2.1.29. –virt-cpus
        • 3.1.3.2.1.30. –virt-disk-driver
        • 3.1.3.2.1.31. –virt-file-size
        • 3.1.3.2.1.32. –virt-path
        • 3.1.3.2.1.33. –virt-ram
        • 3.1.3.2.1.34. –virt-type
      • 3.1.3.2.2. Get Kickstart (getks)
    • 3.1.3.3. Systems
      • 3.1.3.3.1. Add/Edit Options
        • 3.1.3.3.1.1. –name (required)
        • 3.1.3.3.1.2. –profile (required, if –image not set)
        • 3.1.3.3.1.3. –image (required, if –profile not set)
        • 3.1.3.3.1.4. –boot-files
        • 3.1.3.3.1.5. –clobber
        • 3.1.3.3.1.6. –comment
        • 3.1.3.3.1.7. –enable-gpxe
        • 3.1.3.3.1.8. –fetchable-files
        • 3.1.3.3.1.9. –gateway
        • 3.1.3.3.1.10. –hostname
        • 3.1.3.3.1.11. –in-place
        • 3.1.3.3.1.12. –kickstart
        • 3.1.3.3.1.13. –kopts
        • 3.1.3.3.1.14. –kopts-post
        • 3.1.3.3.1.15. –ksmeta
        • 3.1.3.3.1.16. –ldap-enabled, –ldap-type
        • 3.1.3.3.1.17. –mgmt-classes and –mgmt-parameters
        • 3.1.3.3.1.18. –monit-enabled
        • 3.1.3.3.1.19. –name-servers
        • 3.1.3.3.1.20. –name-servers-search
        • 3.1.3.3.1.21. –netboot-enabled
        • 3.1.3.3.1.22. –owners
        • 3.1.3.3.1.23. –power-address, –power-type, –power-user, –power-password, –power-id
        • 3.1.3.3.1.24. –proxy
        • 3.1.3.3.1.25. –redhat-management-key
        • 3.1.3.3.1.26. –redhat-management-server
        • 3.1.3.3.1.27. –repos-enabled
        • 3.1.3.3.1.28. –server
        • 3.1.3.3.1.29. –status
        • 3.1.3.3.1.30. –template-files
        • 3.1.3.3.1.31. –template-remote-kickstarts
        • 3.1.3.3.1.32. –virt-auto-boot
        • 3.1.3.3.1.33. –virt-cpus
        • 3.1.3.3.1.34. –virt-disk-driver
        • 3.1.3.3.1.35. –virt-file-size
        • 3.1.3.3.1.36. –virt-path
        • 3.1.3.3.1.37. –virt-pxe-boot
        • 3.1.3.3.1.38. –virt-ram
        • 3.1.3.3.1.39. –virt-type
      • 3.1.3.3.2. Interface Specific Commands
        • 3.1.3.3.2.1. –interface
        • 3.1.3.3.2.2. –bonding-opts and –bridge-opts
        • 3.1.3.3.2.3. –dns-name
        • 3.1.3.3.2.4. –interface-type and –interface-master
        • 3.1.3.3.2.5. –ip-address
        • 3.1.3.3.2.6. –ipv6-address
        • 3.1.3.3.2.7. –ipv6-autoconfiguration
        • 3.1.3.3.2.8. –ipv6-default-device
        • 3.1.3.3.2.9. –ipv6-secondaries
        • 3.1.3.3.2.10. –ipv6-mtu
        • 3.1.3.3.2.11. –ipv6-static-routes
        • 3.1.3.3.2.12. –ipv6-default-gateway
        • 3.1.3.3.2.13. –mac-address (–mac)
        • 3.1.3.3.2.14. –mtu
        • 3.1.3.3.2.15. –management
        • 3.1.3.3.2.16. –static
        • 3.1.3.3.2.17. –static-routes
        • 3.1.3.3.2.18. –netmask (formerly –subnet)
        • 3.1.3.3.2.19. –virt-bridge
      • 3.1.3.3.3. Get Kickstart (getks)
      • 3.1.3.3.4. Power Commands
    • 3.1.3.4. Images
    • 3.1.3.5. Repos
      • 3.1.3.5.1. mirror
      • 3.1.3.5.2. name
      • 3.1.3.5.3. rpm-list
      • 3.1.3.5.4. createrepo-flags
      • 3.1.3.5.5. keep-updated
      • 3.1.3.5.6. mirror-locally
      • 3.1.3.5.7. priority
      • 3.1.3.5.8. arch
      • 3.1.3.5.9. yumopts
      • 3.1.3.5.10. breed
    • 3.1.3.6. Management Classes
      • 3.1.3.6.1. name
      • 3.1.3.6.2. comment
      • 3.1.3.6.3. packages
      • 3.1.3.6.4. files
    • 3.1.3.7. File Resources
      • 3.1.3.7.1. Actions
        • 3.1.3.7.1.1. create
        • 3.1.3.7.1.2. remove
      • 3.1.3.7.2. Attributes
        • 3.1.3.7.2.1. mode
        • 3.1.3.7.2.2. group
        • 3.1.3.7.2.3. user
        • 3.1.3.7.2.4. path
        • 3.1.3.7.2.5. template
      • 3.1.3.7.3. Example:
    • 3.1.3.8. Package Resources
      • 3.1.3.8.1. Actions
        • 3.1.3.8.1.1. install
        • 3.1.3.8.1.2. uninstall
      • 3.1.3.8.2. Attributes
        • 3.1.3.8.2.1. installer
        • 3.1.3.8.2.2. version
      • 3.1.3.8.3. Example:
• 3.2. Direct Commands
  • 3.2.1. Check
  • 3.2.2. Sync
    • 3.2.2.1. How Sync Works
  • 3.2.3. Distro Signatures
    • 3.2.3.1. Distro Signatures File
  • 3.2.4. CLI Commands
    • 3.2.4.1. cobbler signature report
    • 3.2.4.2. cobbler signature update
  • 3.2.5. Import
    • 3.2.5.1. Alternative set-up from existing filesystem
    • 3.2.5.2. Importing Trees
    • 3.2.5.3. Kickstarts
    • 3.2.5.4. Associated server set-up
      • 3.2.5.4.1. Firewall
      • 3.2.5.4.2. SELinux
      • 3.2.5.4.3. Services
    • 3.2.5.5. Using the server
      • 3.2.5.5.1. PXE
      • 3.2.5.5.2. Reinstallation
      • 3.2.5.5.3. Virtualization
  • 3.2.6. Reposync
  • 3.2.7. Build ISO
  • 3.2.8. Command Line Search
    • 3.2.8.1. Examples
    • 3.2.8.2. A Note About Types And Wildcards
    • 3.2.8.3. API Usage
  • 3.2.9. Replication
    • 3.2.9.1. Transferring More Than Just Metadata
    • 3.2.9.2. Setup
    • 3.2.9.3. How It Works
    • 3.2.9.4. Limitations
    • 3.2.9.5. Common Use Cases
      • 3.2.9.5.1. High Availability / Disaster Recovery
      • 3.2.9.5.2. Load Balancing
      • 3.2.9.5.3. Multiple Geographies
  • 3.2.10. Validate Kickstart
  • 3.2.11. ACL Setup
    • 3.2.11.1. Using File System ACLs
  • 3.2.12. Dynamic Settings
    • 3.2.12.1. cobbler setting edit
    • 3.2.12.2. cobbler setting report
  • 3.2.13. Version
• 3.3. Settings
  • 3.3.1. Dynamic Settings
    • 3.3.1.1. Enabling Dynamic Settings
    • 3.3.1.2. Caveats
      • 3.3.1.2.1. CLI Commands
  • 3.3.2. Complete Settings List
    • 3.3.2.1. allow_duplicate_hostnames
    • 3.3.2.2. allow_duplicate_ips
    • 3.3.2.3. allow_duplicate_macs
    • 3.3.2.4. allow_dynamic_settings
    • 3.3.2.5. anamon_enabled
    • 3.3.2.6. bind_chroot_path
    • 3.3.2.7. bind_master
    • 3.3.2.8. build_reporting_email
    • 3.3.2.9. build_reporting_enabled
    • 3.3.2.10. build_reporting_sender
    • 3.3.2.11. build_reporting_smtp_server
    • 3.3.2.12. build_reporting_subject
    • 3.3.2.13. build_reporting_to_address
    • 3.3.2.14. buildisodir
    • 3.3.2.15. cheetah_import_whitelist
    • 3.3.2.16. client_use_localhost
    • 3.3.2.17. cobbler_master
    • 3.3.2.18. consoles
    • 3.3.2.19. createrepo_flags
    • 3.3.2.20. default_deployment_method
    • 3.3.2.21. default_kickstart
    • 3.3.2.22. default_name_servers
    • 3.3.2.23. default_name_servers_search
    • 3.3.2.24. default_ownership
    • 3.3.2.25. default_password_crypted
    • 3.3.2.26. default_template_type
    • 3.3.2.27. default_virt_bridge
    • 3.3.2.28. default_virt_disk_driver
    • 3.3.2.29. default_virt_file_size
    • 3.3.2.30. default_virt_ram
    • 3.3.2.31. default_virt_type
    • 3.3.2.32. enable_gpxe
    • 3.3.2.33. enable_menu
    • 3.3.2.34. func_auto_setup
    • 3.3.2.35. func_master
    • 3.3.2.36. http_port
    • 3.3.2.37. isc_set_host_name
    • 3.3.2.38. iso_template_dir
    • 3.3.2.39. kerberos_realm
    • 3.3.2.40. kernel_options
    • 3.3.2.41. kernel_options_s390x
    • 3.3.2.42. ldap_anonymous_bind
    • 3.3.2.43. ldap_base_dn
    • 3.3.2.44. ldap_management_default_type
    • 3.3.2.45. ldap_port
    • 3.3.2.46. ldap_search_bind_dn
    • 3.3.2.47. ldap_search_passwd
    • 3.3.2.48. ldap_search_prefix
    • 3.3.2.49. ldap_server
    • 3.3.2.50. ldap_tls
    • 3.3.2.51. ldap_tls_cacertfile
    • 3.3.2.52. ldap_tls_keyfile
    • 3.3.2.53. ldap_tls_certfile
    • 3.3.2.54. manage_dhcp
    • 3.3.2.55. manage_dns
    • 3.3.2.56. manage_forward_zones
    • 3.3.2.57. manage_reverse_zones
    • 3.3.2.58. manage_rsync
    • 3.3.2.59. manage_tftpd
    • 3.3.2.60. mgmt_classes
    • 3.3.2.61. mgmt_parameters
    • 3.3.2.62. next_server
    • 3.3.2.63. power_management_default_type
    • 3.3.2.64. power_template_dir
    • 3.3.2.65. puppet_auto_setup
    • 3.3.2.66. puppetca_path
    • 3.3.2.67. pxe_just_once
    • 3.3.2.68. pxe_template_dir
    • 3.3.2.69. redhat_management_key
    • 3.3.2.70. redhat_management_permissive
    • 3.3.2.71. redhat_management_server
    • 3.3.2.72. redhat_management_type
    • 3.3.2.73. register_new_installs
    • 3.3.2.74. remove_old_puppet_certs_automatically
    • 3.3.2.75. replicate_rsync_options
    • 3.3.2.76. reposync_flags
    • 3.3.2.77. restart_dhcp
    • 3.3.2.78. restart_dns
    • 3.3.2.79. restart_xinetd
    • 3.3.2.80. run_install_triggers
    • 3.3.2.81. scm_track_enabled
    • 3.3.2.82. scm_track_mode
    • 3.3.2.83. serializer_pretty_json
    • 3.3.2.84. server
    • 3.3.2.85. sign_puppet_certs_automatically
    • 3.3.2.86. snippetsdir
    • 3.3.2.87. template_remote_kickstarts
    • 3.3.2.88. virt_auto_boot
    • 3.3.2.89. webdir
    • 3.3.2.90. xmlrpc_port
    • 3.3.2.91. yum_distro_priority
    • 3.3.2.92. yum_post_install_mirror
    • 3.3.2.93. yumdownloader_flags
• 3.4. Managing services with cobbler
  • 3.4.1. DHCP
    • 3.4.1.1. When To Enable DHCP Management
    • 3.4.1.2. Setting up
      • 3.4.1.2.1. ISC considerations
      • 3.4.1.2.2. DNSMASQ considerations
    • 3.4.1.3. How It Works
      • 3.4.1.3.1. Itanium: additional requirements
      • 3.4.1.3.2. ISC and OMAPI for dynamic DHCP updates
      • 3.4.1.3.3. Static IPs
      • 3.4.1.3.4. If You Don’t Have Any DHCP
  • 3.4.2. DNS
    • 3.4.2.1. General considerations
    • 3.4.2.2. BIND considerations
      • 3.4.2.2.1. Restricting Zone Scope
      • 3.4.2.2.2. Default and zone-specific templating
      • 3.4.2.2.3. Other
    • 3.4.2.3. DNSMASQ considerations
  • 3.4.3. rsync
  • 3.4.4. TFTP
• 3.5. Kickstart Templating
  • 3.5.1. Down The Rabbit Hole
  • 3.5.2. First off
  • 3.5.3. Hierarchy
  • 3.5.4. Basic Variable substitution
  • 3.5.5. Snippets
  • 3.5.6. Escaping
  • 3.5.7. Built In Variables
    • 3.5.7.1. What variables can I use?
  • 3.5.8. Checking For Variables That Might Not Exist
  • 3.5.9. Networking
  • 3.5.10. Built-in functions and extensibility
  • 3.5.11. Raw Escaping
    • 3.5.11.1. Raw escaping and Snippets
  • 3.5.12. Conditionals
  • 3.5.13. “Stanza” Support
  • 3.5.14. Validation
  • 3.5.15. Looking at results
  • 3.5.16. Calling Python Code
  • 3.5.17. Comments
  • 3.5.18. Further info
  • 3.5.19. Other Resources
• 3.6. Snippets
  • 3.6.1. Advanced Snippets
  • 3.6.2. Subdirectories
  • 3.6.3. Variable Snippet Names
  • 3.6.4. Cobbler SNIPPETs versus Cheetah #include
  • 3.6.5. Scoping issues
  • 3.6.6. Recursive or Nested Snippets
  • 3.6.7. Kickstart Snippet Cookbook
    • 3.6.7.1. Adding an SSH key to authorized keys
    • 3.6.7.2. Disk Configuration
    • 3.6.7.3. Another partitioning example
    • 3.6.7.4. Package Selection by hostname
    • 3.6.7.5. Package Selection by profile name
    • 3.6.7.6. Root Password Generation
    • 3.6.7.7. VMWare Detection
    • 3.6.7.8. RHEL Installation Keys
    • 3.6.7.9. Configure Timezone Based on Hostname
    • 3.6.7.10. Install HP Proliant Support Pack (PSP)
• 3.7. Package Management and Mirroring
  • 3.7.1. About
  • 3.7.2. Why would you be interested in this?
  • 3.7.3. How-To
  • 3.7.4. RHN
  • 3.7.5. Post Install Yum Usage
  • 3.7.6. Updates And Cron
  • 3.7.7. Also Apt
  • 3.7.8. Saving Space
  • 3.7.9. To Review
• 3.8. File System Information
  • 3.8.1. /var/log/cobbler
  • 3.8.2. /var/www/cobbler
    • 3.8.2.1. /var/www/cobbler/web/
    • 3.8.2.2. /var/www/cobbler/webui/
    • 3.8.2.3. /var/www/cobbler/aux/
    • 3.8.2.4. /var/www/cobbler/svc/
    • 3.8.2.5. /var/www/cobbler/images/
    • 3.8.2.6. /var/www/cobbler/ks_mirror/
    • 3.8.2.7. /var/www/cobbler/repo_mirror/
  • 3.8.3. /var/lib/cobbler/
    • 3.8.3.1. /var/lib/cobbler/config/
    • 3.8.3.2. /var/lib/cobbler/backups/
    • 3.8.3.3. /var/lib/cobbler/kickstarts/
    • 3.8.3.4. /var/lib/cobbler/snippets/
    • 3.8.3.5. /var/lib/cobbler/triggers/
  • 3.8.4. /usr/share/cobbler/web
  • 3.8.5. /etc/cobbler/
    • 3.8.5.1. /etc/cobbler/power
    • 3.8.5.2. /etc/cobbler/pxe
    • 3.8.5.3. /etc/cobbler/zone_templates
    • 3.8.5.4. /etc/cobbler/reporting
  • 3.8.6. /usr/lib/python${VERSION}/site-packages/cobbler/
    • 3.8.6.1. /usr/lib/python${VERSION}/site-packages/cobbler/modules/