fix #1959: remove any information regarding 'auto'
[pve-docs.git] / qm-cloud-init-opts.adoc
CommitLineData
65c8d802
DM
1`cipassword`: `<string>` ::
2
3Password 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.
4
5`citype`: `<configdrive2 | nocloud>` ::
6
7Specifies 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.
8
9`ciuser`: `<string>` ::
10
11User name to change ssh keys and password for instead of the image's configured default user.
12
13`ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
14
15Specify IP addresses and gateways for the corresponding interface.
16+
17IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
18+
19The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
2da12b29 20SLAAC is not supported by cloud-init but at least netplan activates SLAAC when selecting 'dhcp' so it should work with up-to-date netplan versions.
65c8d802
DM
21+
22If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
23
24`gw`=`<GatewayIPv4>` ;;
25
26Default gateway for IPv4 traffic.
27+
28NOTE: Requires option(s): `ip`
29
30`gw6`=`<GatewayIPv6>` ;;
31
32Default gateway for IPv6 traffic.
33+
34NOTE: Requires option(s): `ip6`
35
36`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
37
38IPv4 address in CIDR format.
39
40`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
41
42IPv6 address in CIDR format.
43
44`nameserver`: `<string>` ::
45
46Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
47
48`searchdomain`: `<string>` ::
49
50Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
51
52`sshkeys`: `<string>` ::
53
54Setup public SSH keys (one key per line, OpenSSH format).
55