]> git.proxmox.com Git - pve-docs.git/blame - qm-cloud-init-opts.adoc
qm: pct: mention move-disk for storage and reassign
[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
12Specify a custom file containing all network data passed to the VM via cloud-init.
13
14`user`=`<volume>` ;;
15
16Specify a custom file containing all user data passed to the VM via cloud-init.
5370fa8c
TL
17
18`vendor`=`<volume>` ;;
19
20Specify a custom file containing all vendor data passed 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
30`ciuser`: `<string>` ::
31
32User name to change ssh keys and password for instead of the image's configured default user.
33
34`ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
35
36Specify IP addresses and gateways for the corresponding interface.
37+
38IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
39+
4772952b
TL
40The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
41gateway should be provided.
d2656385
TL
42For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
43cloud-init 19.4 or newer.
65c8d802 44+
4772952b
TL
45If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
46dhcp on IPv4.
65c8d802
DM
47
48`gw`=`<GatewayIPv4>` ;;
49
50Default gateway for IPv4 traffic.
51+
52NOTE: Requires option(s): `ip`
53
54`gw6`=`<GatewayIPv6>` ;;
55
56Default gateway for IPv6 traffic.
57+
58NOTE: Requires option(s): `ip6`
59
60`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
61
62IPv4 address in CIDR format.
63
64`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
65
66IPv6 address in CIDR format.
67
68`nameserver`: `<string>` ::
69
4772952b
TL
70Sets DNS server IP address for a container. Create will'
71 .' automatically use the setting from the host if neither searchdomain nor nameserver'
72 .' are set.
65c8d802
DM
73
74`searchdomain`: `<string>` ::
75
4772952b
TL
76Sets DNS search domains for a container. Create will'
77 .' automatically use the setting from the host if neither searchdomain nor nameserver'
78 .' are set.
65c8d802
DM
79
80`sshkeys`: `<string>` ::
81
82Setup public SSH keys (one key per line, OpenSSH format).
83