]> git.proxmox.com Git - pve-docs.git/blame - qm-cloud-init-opts.adoc
bump version to 8.2.1
[pve-docs.git] / qm-cloud-init-opts.adoc
CommitLineData
5370fa8c 1`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
95895385
TL
2
3Specify custom files to replace the automatically generated ones at start.
4
5`meta`=`<volume>` ;;
6
4772952b
TL
7Specify a custom file containing all meta data passed to the VM via"
8 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
95895385
TL
9
10`network`=`<volume>` ;;
11
9d2e98ed 12To pass a custom file containing all network data to the VM via cloud-init.
95895385
TL
13
14`user`=`<volume>` ;;
15
9d2e98ed 16To pass a custom file containing all user data to the VM via cloud-init.
5370fa8c
TL
17
18`vendor`=`<volume>` ;;
19
9d2e98ed 20To pass a custom file containing all vendor data to the VM via cloud-init.
95895385 21
65c8d802
DM
22`cipassword`: `<string>` ::
23
24Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
25
d2656385 26`citype`: `<configdrive2 | nocloud | opennebula>` ::
65c8d802
DM
27
28Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
29
c8eee6ff 30`ciupgrade`: `<boolean>` ('default =' `1`)::
159464a9
TL
31
32do an automatic package upgrade after the first boot.
33
65c8d802
DM
34`ciuser`: `<string>` ::
35
36User name to change ssh keys and password for instead of the image's configured default user.
37
38`ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
39
40Specify IP addresses and gateways for the corresponding interface.
41+
42IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
43+
4772952b
TL
44The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
45gateway should be provided.
d2656385
TL
46For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
47cloud-init 19.4 or newer.
65c8d802 48+
4772952b
TL
49If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
50dhcp on IPv4.
65c8d802
DM
51
52`gw`=`<GatewayIPv4>` ;;
53
54Default gateway for IPv4 traffic.
55+
56NOTE: Requires option(s): `ip`
57
58`gw6`=`<GatewayIPv6>` ;;
59
60Default gateway for IPv6 traffic.
61+
62NOTE: Requires option(s): `ip6`
63
64`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
65
66IPv4 address in CIDR format.
67
68`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
69
70IPv6 address in CIDR format.
71
72`nameserver`: `<string>` ::
73
de786b48 74Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
65c8d802
DM
75
76`searchdomain`: `<string>` ::
77
de786b48 78Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
65c8d802
DM
79
80`sshkeys`: `<string>` ::
81
82Setup public SSH keys (one key per line, OpenSSH format).
83