2fa17351703363cf90d99447f794a60d804b3dd5
[pve-docs.git] / qm-cloud-init-opts.adoc
1 `cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
2
3 Specify custom files to replace the automatically generated ones at start.
4
5 `meta`=`<volume>` ;;
6
7 Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
8
9 `network`=`<volume>` ;;
10
11 Specify a custom file containing all network data passed to the VM via cloud-init.
12
13 `user`=`<volume>` ;;
14
15 Specify a custom file containing all user data passed to the VM via cloud-init.
16
17 `cipassword`: `<string>` ::
18
19 Password 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.
20
21 `citype`: `<configdrive2 | nocloud>` ::
22
23 Specifies 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.
24
25 `ciuser`: `<string>` ::
26
27 User name to change ssh keys and password for instead of the image's configured default user.
28
29 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
30
31 Specify IP addresses and gateways for the corresponding interface.
32 +
33 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
34 +
35 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
36 +
37 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
38
39 `gw`=`<GatewayIPv4>` ;;
40
41 Default gateway for IPv4 traffic.
42 +
43 NOTE: Requires option(s): `ip`
44
45 `gw6`=`<GatewayIPv6>` ;;
46
47 Default gateway for IPv6 traffic.
48 +
49 NOTE: Requires option(s): `ip6`
50
51 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
52
53 IPv4 address in CIDR format.
54
55 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
56
57 IPv6 address in CIDR format.
58
59 `nameserver`: `<string>` ::
60
61 Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
62
63 `searchdomain`: `<string>` ::
64
65 Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
66
67 `sshkeys`: `<string>` ::
68
69 Setup public SSH keys (one key per line, OpenSSH format).
70