Configuration options reference

The following is an overview of all available configuration options in cloudbase-init.

DEFAULT

debug

Type:: boolean
Default:: False
Mutable:: This option can be changed without restarting.

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

log_config_append

Type:: string
Default:: <None>
Mutable:: This option can be changed without restarting.

The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).

Deprecated Variations
Group	Name
DEFAULT	log-config
DEFAULT	log_config

log_date_format

Type:: string
Default:: %Y-%m-%d %H:%M:%S

Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.

log_file

Type:: string
Default:: <None>

(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

Deprecated Variations
Group	Name
DEFAULT	logfile

log_dir

Type:: string
Default:: <None>

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

Deprecated Variations
Group	Name
DEFAULT	logdir

watch_log_file

Type:: boolean
Default:: False

Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:: This function is known to have bene broken for long time, and depends on the unmaintained library

use_syslog

Type:: boolean
Default:: False

Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

use_journal

Type:: boolean
Default:: False

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility

Type:: string
Default:: LOG_USER

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_json

Type:: boolean
Default:: False

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use_stderr

Type:: boolean
Default:: False

Log output to standard error. This option is ignored if log_config_append is set.

use_eventlog

Type:: boolean
Default:: False

Log output to Windows Event Log.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason:: Windows support is no longer maintained.

log_color

Type:: boolean
Default:: False

(Optional) Set the ‘color’ key according to log levels. This option takes effect only when logging to stderr or stdout is used. This option is ignored if log_config_append is set.

log_rotate_interval

Type:: integer
Default:: 1

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.

log_rotate_interval_type

Type:: string
Default:: days
Valid Values:: Seconds, Minutes, Hours, Days, Weekday, Midnight

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

max_logfile_count

Type:: integer
Default:: 30

Maximum number of rotated log files.

max_logfile_size_mb

Type:: integer
Default:: 200

Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.

log_rotation_type

Type:: string
Default:: none
Valid Values:: interval, size, none

Log rotation type.

Possible values

interval: Rotate logs at predefined time intervals.
size: Rotate logs once they reach a predefined size.
none: Do not rotate log files.

logging_context_format_string

Type:: string
Default:: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

logging_default_format_string

Type:: string
Default:: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix

Type:: string
Default:: %(funcName)s %(pathname)s:%(lineno)d

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix

Type:: string
Default:: %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format

Type:: string
Default:: %(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

default_log_levels

Type:: list
Default:: ['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

publish_errors

Type:: boolean
Default:: False

Enables or disables publication of error events.

instance_format

Type:: string
Default:: "[instance: %(uuid)s] "

The format for an instance that is passed with the log message.

instance_uuid_format

Type:: string
Default:: "[instance: %(uuid)s] "

The format for an instance UUID that is passed with the log message.

rate_limit_interval

Type:: integer
Default:: 0

Interval, number of seconds, of log rate limiting.

rate_limit_burst

Type:: integer
Default:: 0

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level

Type:: string
Default:: CRITICAL
Valid Values:: CRITICAL, ERROR, INFO, WARNING, DEBUG, ‘’

Log level name used by rate limiting. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations

Type:: boolean
Default:: False

Enables or disables fatal status of deprecations.

allow_reboot

Type:: boolean
Default:: True

Allows OS reboots requested by plugins

stop_service_on_exit

Type:: boolean
Default:: True

In case of execution as a service, specifies if the service must be gracefully stopped before exiting

check_latest_version

Type:: boolean
Default:: False

Check if there is a newer version of cloudbase-init available. If this option is activated, a log message will be emitted if there is a newer version available.

retry_count

Type:: integer
Default:: 5

Max. number of attempts for fetching metadata in case of transient errors

retry_count_interval

Type:: floating point
Default:: 4

Interval between attempts in case of transient errors, expressed in seconds

mtools_path

Type:: string
Default:: <None>

Path to “mtools” program suite, used for interacting with VFAT filesystems

bsdtar_path

Type:: string
Default:: bsdtar.exe

Path to “bsdtar”, used to extract ISO ConfigDrive files

netbios_host_name_compatibility

Type:: boolean
Default:: True

Truncates the hostname to 15 characters for Netbios compatibility

logging_serial_port_settings

Type:: string
Default:: <None>

Serial port logging settings. Format: “port,baudrate,parity,bytesize”, e.g.: “COM1,115200,N,8”. Set to None (default) to disable.

activate_windows

Type:: boolean
Default:: False

Activates Windows automatically

set_kms_product_key

Type:: boolean
Default:: False

Sets the KMS product key for this operating system

set_avma_product_key

Type:: boolean
Default:: False

Sets the AVMA product key for this operating system

kms_host

Type:: string
Default:: <None>

The KMS host address in form <host>[:<port>], e.g: “kmshost:1688”

log_licensing_info

Type:: boolean
Default:: True

Logs the operating system licensing information

winrm_enable_basic_auth

Type:: boolean
Default:: True

Enables basic authentication for the WinRM HTTPS listener

winrm_configure_http_listener

Type:: boolean
Default:: False

Configures the WinRM HTTP listener

winrm_configure_https_listener

Type:: boolean
Default:: True

Configures the WinRM HTTPS listener

volumes_to_extend

Type:: list
Default:: <None>

List of volumes that need to be extended if contiguous space is available on the disk. By default all the available volumes can be extended. Volumes must be specified using a comma separated list of volume indexes, e.g.: “1,2”

san_policy

Type:: string
Default:: <None>
Valid Values:: OnlineAll, OfflineAll, OfflineShared

If not None, the SAN policy is set to the given value

local_scripts_path

Type:: string
Default:: <None>

Path location containing scripts to be executed when the plugin runs

mtu_use_dhcp_config

Type:: boolean
Default:: True

Configures the network interfaces MTU based on the values provided via DHCP

username

Type:: string
Default:: Admin

User to be added to the system or updated if already existing

groups

Type:: list
Default:: ['Administrators']

List of local groups to which the user specified in “username” will be added

rename_admin_user

Type:: boolean
Default:: False

Renames the builtin admin user instead of creating a new user

heat_config_dir

Type:: string
Default:: C:\cfn

The directory where the Heat configuration files must be saved

ntp_enable_service

Type:: boolean
Default:: True

Enables the NTP client service

ntp_use_dhcp_config

Type:: boolean
Default:: False

Configures NTP client time synchronization using the NTP servers provided via DHCP

real_time_clock_utc

Type:: boolean
Default:: False

Sets the real time clock to use universal time (True) or local time (False)

inject_user_password

Type:: boolean
Default:: True

Set the password provided in the configuration. If False or no password is provided, a random one will be set

first_logon_behaviour

Type:: string
Default:: clear_text_injected_only
Valid Values:: clear_text_injected_only, no, always

Control the behaviour of what happens at next logon. If this option is set to always, then the user will be forced to change the password at next logon. If it is set to clear_text_injected_only, then the user will have to change the password only if the password is a clear text password, coming from the metadata. The last option is no, when the user is never forced to change the password.

metadata_services

Type:: list
Default:: ['cloudbaseinit.metadata.services.httpservice.HttpService', 'cloudbaseinit.metadata.services.configdrive.ConfigDriveService', 'cloudbaseinit.metadata.services.ec2service.EC2Service', 'cloudbaseinit.metadata.services.maasservice.MaaSHttpService', 'cloudbaseinit.metadata.services.cloudstack.CloudStack', 'cloudbaseinit.metadata.services.opennebulaservice.OpenNebulaService']

List of enabled metadata service classes, to be tested for availability in the provided order. The first available service will be used to retrieve metadata

plugins

Type:: list
Default:: ['cloudbaseinit.plugins.common.mtu.MTUPlugin', 'cloudbaseinit.plugins.windows.ntpclient.NTPClientPlugin', 'cloudbaseinit.plugins.common.sethostname.SetHostNamePlugin', 'cloudbaseinit.plugins.windows.createuser.CreateUserPlugin', 'cloudbaseinit.plugins.common.networkconfig.NetworkConfigPlugin', 'cloudbaseinit.plugins.windows.licensing.WindowsLicensingPlugin', 'cloudbaseinit.plugins.common.sshpublickeys.SetUserSSHPublicKeysPlugin', 'cloudbaseinit.plugins.windows.extendvolumes.ExtendVolumesPlugin', 'cloudbaseinit.plugins.common.userdata.UserDataPlugin', 'cloudbaseinit.plugins.common.setuserpassword.SetUserPasswordPlugin', 'cloudbaseinit.plugins.windows.winrmlistener.ConfigWinRMListenerPlugin', 'cloudbaseinit.plugins.windows.winrmcertificateauth.ConfigWinRMCertificateAuthPlugin', 'cloudbaseinit.plugins.common.localscripts.LocalScriptsPlugin']

List of enabled plugin classes, to be executed in the provided order

user_data_plugins

Type:: list
Default:: ['cloudbaseinit.plugins.common.userdataplugins.parthandler.PartHandlerPlugin', 'cloudbaseinit.plugins.common.userdataplugins.cloudconfig.CloudConfigPlugin', 'cloudbaseinit.plugins.common.userdataplugins.cloudboothook.CloudBootHookPlugin', 'cloudbaseinit.plugins.common.userdataplugins.shellscript.ShellScriptPlugin', 'cloudbaseinit.plugins.common.userdataplugins.multipartmixed.MultipartMixedPlugin', 'cloudbaseinit.plugins.common.userdataplugins.heat.HeatPlugin']

List of enabled userdata content plugins

cloud_config_plugins

Type:: list
Default:: []

List which contains the name of the cloud config plugins ordered by priority.

rdp_set_keepalive

Type:: boolean
Default:: True

Sets the RDP KeepAlive policy

bcd_boot_status_policy

Type:: string
Default:: <None>
Valid Values:: ignoreallfailures

Sets the Windows BCD boot status policy

bcd_enable_auto_recovery

Type:: boolean
Default:: False

Enables or disables the BCD auto recovery

set_unique_boot_disk_id

Type:: boolean
Default:: True

Sets a new random unique id on the boot disk to avoid collisions

display_idle_timeout

Type:: integer
Default:: 0

The idle timeout, in seconds, before powering off the display. Set 0 to leave the display always on

page_file_volume_labels

Type:: list
Default:: []

Labels of volumes on which a Windows page file needs to be created. E.g.: “Temporary Storage”

page_file_volume_mount_points

Type:: list
Default:: []

Volume mount points on which a Windows page file needs to be created. E.g.: “\?GLOBALROOTdeviceHarddisk1Partition1"

trim_enabled

Type:: boolean
Default:: False

Enables or disables TRIM delete notifications for the underlying storage device.

process_userdata

Type:: boolean
Default:: True

Processes the userdata content based on the type, e.g. executing a PowerShell script

userdata_save_path

Type:: string
Default:: <None>

Copies the userdata to the given file path. The path can include environment variables that will be expanded, e.g. “%SYSTEMDRIVE%CloudbaseInitUserData.bin”

enable_automatic_updates

Type:: boolean
Default:: <None>

If set, enables or disables automatic operating system updates.

metadata_report_provisioning_started

Type:: boolean
Default:: False

Reports to the metadata service that provisioning has started

metadata_report_provisioning_completed

Type:: boolean
Default:: False

Reports to the metadata service that provisioning completed successfully or failed

ephemeral_disk_volume_label

Type:: string
Default:: <None>

Ephemeral disk volume label, e.g.: “Temporary Storage”

ephemeral_disk_volume_mount_point

Type:: string
Default:: <None>

Ephemeral disk volume mount point, e.g.:”\?GLOBALROOTdeviceHarddisk1Partition1"

ephemeral_disk_data_loss_warning_path

Type:: string
Default:: <None>

Ephemeral disk data loss warning path, relative to the ephemeral disk volume path. E.g.: DATALOSS_WARNING_README.txt

user_password_length

Type:: integer
Default:: 20

The length of the generated password for the user defined by the username config option.

azure

transport_cert_store_name

Type:: string
Default:: Windows Azure Environment

Certificate store name for metadata certificates

cloudstack

metadata_base_url

Type:: string
Default:: http://10.1.1.1/

The base URL where the service looks for metadata

Deprecated Variations
Group	Name
DEFAULT	cloudstack_metadata_ip

password_server_port

Type:: integer
Default:: 8080

The port number used by the Password Server.

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

add_metadata_private_ip_route

Type:: boolean
Default:: False

Add a route for the metadata ip address to the gateway

config_drive

raw_hdd

Type:: boolean
Default:: True

Look for an ISO config drive in raw HDDs

Deprecated Variations
Group	Name
DEFAULT	config_drive_raw_hhd

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

cdrom

Type:: boolean
Default:: True

Look for a config drive in the attached cdrom drives

Deprecated Variations
Group	Name
DEFAULT	config_drive_cdrom

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

vfat

Type:: boolean
Default:: True

Look for a config drive in VFAT filesystems

Deprecated Variations
Group	Name
DEFAULT	config_drive_vfat

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

types

Type:: list
Default:: ['vfat', 'iso']

Supported formats of a configuration drive

Deprecated Variations
Group	Name
DEFAULT	config_drive_types

locations

Type:: list
Default:: ['cdrom', 'hdd', 'partition']

Supported configuration drive locations

Deprecated Variations
Group	Name
DEFAULT	config_drive_locations

ec2

metadata_base_url

Type:: string
Default:: http://169.254.169.254/

The base URL where the service looks for metadata

Deprecated Variations
Group	Name
DEFAULT	ec2_metadata_base_url

add_metadata_private_ip_route

Type:: boolean
Default:: True

Add a route for the metadata ip address to the gateway

Deprecated Variations
Group	Name
DEFAULT	ec2_add_metadata_private_ip_route

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

gce

metadata_base_url

Type:: string
Default:: http://metadata.google.internal/computeMetadata/v1/

The base URL where the service looks for metadata

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

maas

metadata_base_url

Type:: string
Default:: <None>

The base URL for MaaS metadata

Deprecated Variations
Group	Name
DEFAULT	maas_metadata_url

oauth_consumer_key

Type:: string
Default:: ''

The MaaS OAuth consumer key

Deprecated Variations
Group	Name
DEFAULT	maas_oauth_consumer_key

oauth_consumer_secret

Type:: string
Default:: ''

The MaaS OAuth consumer secret

Deprecated Variations
Group	Name
DEFAULT	maas_oauth_consumer_secret

oauth_token_key

Type:: string
Default:: ''

The MaaS OAuth token key

Deprecated Variations
Group	Name
DEFAULT	maas_oauth_token_key

oauth_token_secret

Type:: string
Default:: ''

The MaaS OAuth token secret

Deprecated Variations
Group	Name
DEFAULT	maas_oauth_token_secret

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

nocloud

metadata_file

Type:: string
Default:: meta-data

The file name where the service looks formetadata

userdata_file

Type:: string
Default:: user-data

The file name where the service looks foruserdata

openstack

metadata_base_url

Type:: string
Default:: http://169.254.169.254/

The base URL where the service looks for metadata

Deprecated Variations
Group	Name
DEFAULT	metadata_base_url

add_metadata_private_ip_route

Type:: boolean
Default:: True

Add a route for the metadata ip address to the gateway

Deprecated Variations
Group	Name
DEFAULT	add_metadata_private_ip_route

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

ovf

config_file_name

Type:: string
Default:: ovf-env.xml

Configuration file name

drive_label

Type:: string
Default:: OVF ENV

Look for configuration file in drives with this label

ns

Type:: string
Default:: oe

Namespace prefix for ovf environment

packet

metadata_base_url

Type:: string
Default:: https://metadata.packet.net/

The URL where the service looks for metadata

https_allow_insecure

Type:: boolean
Default:: False

Whether to disable the validation of HTTPS certificates.

https_ca_bundle

Type:: string
Default:: <None>

The path to a CA_BUNDLE file or directory with certificates of trusted CAs.

vmwareguestinfo

vmware_rpctool_path

Type:: string
Default:: %ProgramFiles%/VMware/VMware Tools/rpctool.exe

The local path where VMware rpctool is found