[pve-docs.git] / qm-cloud-init-opts.adoc

`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::

Specify custom files to replace the automatically generated ones at start.

`meta`=`<volume>` ;;

Specify a custom file containing all meta data passed to the VM via"
	    ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.

`network`=`<volume>` ;;

Specify a custom file containing all network data passed to the VM via cloud-init.

`user`=`<volume>` ;;

Specify a custom file containing all user data passed to the VM via cloud-init.

`cipassword`: `<string>` ::

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.

`citype`: `<configdrive2 | nocloud | opennebula>` ::

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.

`ciuser`: `<string>` ::

User name to change ssh keys and password for instead of the image's configured default user.

`ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::

Specify IP addresses and gateways for the corresponding interface.
+
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
+
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
gateway should be provided.
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
cloud-init 19.4 or newer.
+
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
dhcp on IPv4.

`gw`=`<GatewayIPv4>` ;;

Default gateway for IPv4 traffic.
+
NOTE: Requires option(s): `ip`

`gw6`=`<GatewayIPv6>` ;;

Default gateway for IPv6 traffic.
+
NOTE: Requires option(s): `ip6`

`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;

IPv4 address in CIDR format.

`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;

IPv6 address in CIDR format.

`nameserver`: `<string>` ::

Sets DNS server IP address for a container. Create will'
	    .' automatically use the setting from the host if neither searchdomain nor nameserver'
	    .' are set.

`searchdomain`: `<string>` ::

Sets DNS search domains for a container. Create will'
	    .' automatically use the setting from the host if neither searchdomain nor nameserver'
	    .' are set.

`sshkeys`: `<string>` ::

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