koan(1)

1KOAN.1(1)                             man                            KOAN.1(1)
2
3
4

6       koan - kickstart over a network, client side helper for cobbler
7

9       koan --server=hostname [--list=type] [--virt|--replace-self|--display]
10       [--profile=name] [--system=name] [--image=name] [--add-reinstall-entry]
11       [--virt-name=name] [--virt-path=path] [--virt-type=type] [--nogfx]
12       [--static-interface=name] [--kexec]
13

15       Koan stands for "kickstart-over-a-network" and is a client-side helper
16       program for use with Cobbler.  koan allows for both network
17       provisioning of new virtualized guests (Xen, QEMU/KVM, VMware) and re-
18       installation of an existing system.
19
20       When invoked, koan requests install information from a remote cobbler
21       boot server, it then kicks off installations based on what is retrieved
22       from cobbler and fed in on the koan command line.   The examples below
23       show the various use cases.
24

26       To browse remote objects on a cobbler server and see what you can
27       install using koan, run one of the following commands:
28
29       koan --server=cobbler.example.org --list=profiles
30
31       koan --server=cobbler.example.org --list=systems
32
33       koan --server=cobbler.example.org --list=images
34

36       To learn more about what you are about to install, run one of the
37       following commands:
38
39       koan --server=cobbler.example.org --display --profile=name
40
41       koan --server=cobbler.example.org --display --system=name
42
43       koan --server=cobbler.example.org --display --image=name
44

46       Using --replace-self will reinstall the existing system the next time
47       you reboot.
48
49       koan --server=cobbler.example.org --replace-self --profile=name
50
51       koan --server=cobbler.example.org --replace-self --system=name
52
53       Additionally, adding the flag --add-reinstall-entry will make it add
54       the entry to grub for reinstallation but will not make it automatically
55       pick that option on the next boot.
56
57       Also the flag --kexec can be appended, which will launch the installer
58       without needing to reboot.  Not all kernels support this option.
59

61       Using --virt will install virtual machines as defined by Cobbler.
62       There are various overrides you can use if not everything in cobbler is
63       defined as you like it.
64
65       koan --server=cobbler.example.org --virt --profile=name
66
67       koan --server=cobbler.example.org --virt --system=name
68
69       koan --server=cobbler.example.org --virt --image=name
70
71       Some of the overrides that can be used with --virt are:
72
73       Flag                Explanation                             Example
74
75       --virt-name         name of virtual machine to create       testmachine
76
77       --virt-type         forces usage of qemu/xen/vmware         qemu
78
79       --virt-bridge       name of bridge device                   virbr0
80
81       --virt-path         overwrite this disk partition           /dev/sda4
82
83       --virt-path         use this directory
84       /opt/myimages
85
86       --virt-path         use this existing LVM volume            VolGroup00
87
88       --nogfx             do not use VNC graphics (Xen only)      (does not
89       take options)
90
91       Nearly all of these variables can also be defined and centrally managed
92       by the Cobbler server.
93
94       If installing virtual machines in environments without DHCP, use of
95       --system instead of --profile is required.  Additionally use
96       --static-interface=eth0 to supply which interface to use to supply
97       network information.  The installer will boot from this virtual
98       interface.  Leaving off --static-interface will result in an
99       unsuccessful network installation.
100

102       Using --update-config will update a system configuration as defined by
103       Cobbler.
104
105       koan --server=cobbler.example.org --update-config
106
107       Additionally, adding the flag --summary will print configuration run
108       stats.
109
110       Koan passes in the system's FQDN in the background during the
111       configuration request. Cobbler will match this FQDN to a configured
112       system defined by Cobbler.
113
114       The FQDN (Fully Qualified Domain Name) maps to the system's hostname
115       field.
116

118       Koan respects the COBBLER_SERVER variable to specify the cobbler server
119       to use.  This is a convenient way to avoid using the --server option
120       for each command.  This variable is set automatically on systems
121       installed via cobbler, assuming standard kickstart templates are used.
122       If you need to change this on an installed system, edit
123       /etc/profile.d/cobbler.{csh,sh}.
124

126       Reading the cobbler manpage and cobbler.github.io is highly
127       recommended.
128
129       The mailing list is cobbler@lists.fedorahosted.org.
130
131       Subscribe at https://fedorahosted.org/mailman/listinfo/cobbler
132

134       Michael DeHaan <michael.dehaan AT gmail>
135
136
137
1382.8.4                             2018-11-17                         KOAN.1(1)

NAME

SYNOPSIS

DESCRIPTION

LISTING REMOTE COBBLER OBJECTS

LEARNING MORE ABOUT REMOTE COBBLER OBJECTS

REINSTALLING EXISTING SYSTEMS

INSTALLING VIRTUALIZED SYSTEMS

CONFIGURATION MANAGEMENT

ENVIRONMENT VARIABLES

ADDITIONAL

AUTHOR