.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "KOAN.1 1" .TH KOAN.1 1 "2016-02-12" "2.6.6" "man" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" koan \- kickstart over a network, client side helper for cobbler .SH "SYNOPSIS" .IX Header "SYNOPSIS" koan \-\-server=hostname [\-\-list=type] [\-\-virt|\-\-replace\-self|\-\-display] [\-\-profile=name] [\-\-system=name] [\-\-image=name] [\-\-add\-reinstall\-entry] [\-\-virt\-name=name] [\-\-virt\-path=path] [\-\-virt\-type=type] [\-\-nogfx] [\-\-static\-interface=name] [\-\-kexec] .SH "DESCRIPTION" .IX Header "DESCRIPTION" Koan stands for \*(L"kickstart-over-a-network\*(R" and is a client-side helper program for use with Cobbler. koan allows for both network provisioning of new virtualized guests (Xen, \s-1QEMU/KVM,\s0 VMware) and re-installation of an existing system. .PP When invoked, koan requests install information from a remote cobbler boot server, it then kicks off installations based on what is retrieved from cobbler and fed in on the koan command line. The examples below show the various use cases. .SH "LISTING REMOTE COBBLER OBJECTS" .IX Header "LISTING REMOTE COBBLER OBJECTS" To browse remote objects on a cobbler server and see what you can install using koan, run one of the following commands: .PP koan \-\-server=cobbler.example.org \-\-list=profiles .PP koan \-\-server=cobbler.example.org \-\-list=systems .PP koan \-\-server=cobbler.example.org \-\-list=images .SH "LEARNING MORE ABOUT REMOTE COBBLER OBJECTS" .IX Header "LEARNING MORE ABOUT REMOTE COBBLER OBJECTS" To learn more about what you are about to install, run one of the following commands: .PP koan \-\-server=cobbler.example.org \-\-display \-\-profile=name .PP koan \-\-server=cobbler.example.org \-\-display \-\-system=name .PP koan \-\-server=cobbler.example.org \-\-display \-\-image=name .SH "REINSTALLING EXISTING SYSTEMS" .IX Header "REINSTALLING EXISTING SYSTEMS" Using \-\-replace\-self will reinstall the existing system the next time you reboot. .PP koan \-\-server=cobbler.example.org \-\-replace\-self \-\-profile=name .PP koan \-\-server=cobbler.example.org \-\-replace\-self \-\-system=name .PP Additionally, adding the flag \-\-add\-reinstall\-entry will make it add the entry to grub for reinstallation but will not make it automatically pick that option on the next boot. .PP Also the flag \-\-kexec can be appended, which will launch the installer without needing to reboot. Not all kernels support this option. .SH "INSTALLING VIRTUALIZED SYSTEMS" .IX Header "INSTALLING VIRTUALIZED SYSTEMS" Using \-\-virt will install virtual machines as defined by Cobbler. There are various overrides you can use if not everything in cobbler is defined as you like it. .PP koan \-\-server=cobbler.example.org \-\-virt \-\-profile=name .PP koan \-\-server=cobbler.example.org \-\-virt \-\-system=name .PP koan \-\-server=cobbler.example.org \-\-virt \-\-image=name .PP Some of the overrides that can be used with \-\-virt are: .PP Flag Explanation Example .PP \&\-\-virt\-name name of virtual machine to create testmachine .PP \&\-\-virt\-type forces usage of qemu/xen/vmware qemu .PP \&\-\-virt\-bridge name of bridge device virbr0 .PP \&\-\-virt\-path overwrite this disk partition /dev/sda4 .PP \&\-\-virt\-path use this directory /opt/myimages .PP \&\-\-virt\-path use this existing \s-1LVM\s0 volume VolGroup00 .PP \&\-\-nogfx do not use \s-1VNC\s0 graphics (Xen only) (does not take options) .PP Nearly all of these variables can also be defined and centrally managed by the Cobbler server. .PP If installing virtual machines in environments without \s-1DHCP,\s0 use of \-\-system instead of \-\-profile is required. Additionally use \-\-static\-interface=eth0 to supply which interface to use to supply network information. The installer will boot from this virtual interface. Leaving off \-\-static\-interface will result in an unsuccessful network installation. .SH "CONFIGURATION MANAGEMENT" .IX Header "CONFIGURATION MANAGEMENT" Using \-\-update\-config will update a system configuration as defined by Cobbler. .PP koan \-\-server=cobbler.example.org \-\-update\-config .PP Additionally, adding the flag \-\-summary will print configuration run stats. .PP Koan passes in the system's \s-1FQDN\s0 in the background during the configuration request. Cobbler will match this \s-1FQDN\s0 to a configured system defined by Cobbler. .PP The \s-1FQDN \s0(Fully Qualified Domain Name) maps to the system's hostname field. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" Koan respects the \s-1COBBLER_SERVER\s0 variable to specify the cobbler server to use. This is a convenient way to avoid using the \-\-server option for each command. This variable is set automatically on systems installed via cobbler, assuming standard kickstart templates are used. If you need to change this on an installed system, edit /etc/profile.d/cobbler.{csh,sh}. .SH "ADDITIONAL" .IX Header "ADDITIONAL" Reading the cobbler manpage and www.cobblerd.org is highly recommended. .PP The mailing list is cobbler@lists.fedorahosted.org. .PP Subscribe at https://fedorahosted.org/mailman/listinfo/cobbler .SH "AUTHOR" .IX Header "AUTHOR" Michael DeHaan