]> git.proxmox.com Git - pve-docs.git/blame - qm-cloud-init-opts.adoc
fix #2092: add HA Simulator documentation
[pve-docs.git] / qm-cloud-init-opts.adoc
CommitLineData
95895385
TL
1`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
2
3Specify custom files to replace the automatically generated ones at start.
4
5`meta`=`<volume>` ;;
6
7Specify 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
11Specify a custom file containing all network data passed to the VM via cloud-init.
12
13`user`=`<volume>` ;;
14
15Specify a custom file containing all user data passed to the VM via cloud-init.
16
65c8d802
DM
17`cipassword`: `<string>` ::
18
19Password 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
23Specifies 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
27User 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
31Specify IP addresses and gateways for the corresponding interface.
32+
33IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
34+
35The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
e2d681b3 36For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
65c8d802
DM
37+
38If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
39
40`gw`=`<GatewayIPv4>` ;;
41
42Default gateway for IPv4 traffic.
43+
44NOTE: Requires option(s): `ip`
45
46`gw6`=`<GatewayIPv6>` ;;
47
48Default gateway for IPv6 traffic.
49+
50NOTE: Requires option(s): `ip6`
51
52`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
53
54IPv4 address in CIDR format.
55
56`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
57
58IPv6 address in CIDR format.
59
60`nameserver`: `<string>` ::
61
62Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
63
64`searchdomain`: `<string>` ::
65
66Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
67
68`sshkeys`: `<string>` ::
69
70Setup public SSH keys (one key per line, OpenSSH format).
71