nova.conf - configuration options¶

(String) Default compute node availability_zone.

This option determines the availability zone to be used when it is not specified in the VM creation request. If this option is not set, the default availability zone ‘nova’ is used.

Possible values:

• Any string representing an availability zone name
• ‘nova’ is the default value

(String) This option specifies the name of the availability zone for the internal services. Services like nova-scheduler, nova-network, nova-conductor are internal services. These services will appear in their own internal availability_zone.

Possible values:

• Any string representing an availability zone name
• ‘internal’ is the default value

(Integer) Call timeout

Cell messaging module waits for response(s) to be put into the eventlet queue. This option defines the seconds waited for response from a call to a cell.

Possible values:

• Time in seconds.

(String) Type of cell

When cells feature is enabled the hosts in the OpenStack Compute cloud are partitioned into groups. Cells are configured as a tree. The top-level cell’s cell_type must be set to api. All other cells are defined as a compute cell by default.

Related options:

• compute_api_class: This option must be set to cells api driver for the top-level cell (nova.compute.cells_api.ComputeCellsAPI)
• quota_driver: Disable quota checking for the child cells. (nova.quota.NoopQuotaDriver)

(Integer) DB check interval

Cell state manager updates cell status for all cells from the DB only after this particular interval time is passed. Otherwise cached status are used. If this value is 0 or negative all cell status are updated from the DB whenever a state is needed.

Possible values:

• Interval time, in seconds.

(Boolean) Enable cell functionality

When this functionality is enabled, it lets you to scale an OpenStack Compute cloud in a more distributed fashion without having to use complicated technologies like database and message queue clustering. Cells are configured as a tree. The top-level cell should have a host that runs a nova-api service, but no nova-compute services. Each child cell should run all of the typical nova-* services in a regular Compute cloud except for nova-api. You can think of cells as a normal Compute deployment in that each cell has its own database server and message queue broker.

Related options:

• name: A unique cell name must be given when this functionality is enabled.
• cell_type: Cell type should be defined for all cells.

(Integer) Instance update sync database limit

Number of instances to pull from the database at one time for a sync. If there are more instances to update the results will be paged through.

Possible values:

• Number of instances.

(Integer) Maximum hop count

When processing a targeted message, if the local cell is not the target, a route is defined between neighbouring cells. And the message is processed across the whole routing path. This option defines the maximum hop counts until reaching the target.

Possible values:

• Positive integer value

(Floating point) Mute weight multiplier

Multiplier used to weigh mute children. Mute children cells are recommended to be skipped so their weight is multiplied by this negative value.

Possible values:

• Negative numeric number

(Floating point) Offset weight multiplier

Multiplier used to weigh offset weigher. Cells with higher weight_offsets in the DB will be preferred. The weight_offset is a property of a cell stored in the database. It can be used by a deployer to have scheduling decisions favor or disfavor cells based on the setting.

Possible values:

• Numeric multiplier

(String) RPC driver queue base

When sending a message to another cell by JSON-ifying the message and making an RPC cast to ‘process_message’, a base queue is used. This option defines the base queue name to be used when communicating between cells. Various topics by message type will be appended to this.

Possible values:

• The base queue name to be used when communicating between cells.

(String) Template for cloudpipe instance boot script.

Possible values:

• Any valid path to a cloudpipe instance boot script template

Related options:

The following options are required to configure cloudpipe-managed OpenVPN server.

• dmz_net
• dmz_mask
• cnt_vpn_clients

(IP) Network to push into OpenVPN config.

Note: Above mentioned OpenVPN config can be found at /etc/openvpn/server.conf.

Possible values:

• Any valid IPv4/IPV6 address

Related options:

• boot_script_template - dmz_net is pushed into bootscript.template to configure cloudpipe-managed OpenVPN server

(String) Image ID used when starting up a cloudpipe VPN client.

An empty instance is created and configured with OpenVPN using boot_script_template. This instance would be snapshotted and stored in glance. ID of the stored image is used in ‘vpn_image_id’ to create cloudpipe VPN client.

Possible values:

• Any valid ID of a VPN image

(String) The directory where the Nova binaries are installed.

This option is only relevant if the networking capabilities from Nova are used (see services below). Nova’s networking capabilities are targeted to be fully replaced by Neutron in the future. It is very unlikely that you need to change this option from its default value.

Possible values:

• The full path to a directory.

(String) Represents the message queue topic name used by nova-console service when communicating via the AMQP server. The Nova API uses a message queue to communicate with nova-console to retrieve a console URL for that host.

Possible values

• ‘console’ (default) or any string representing topic exchange name.

(String) Hostname, FQDN or IP address of this host. Must be valid within AMQP key.

Possible values:

• String with hostname, FQDN or IP address. Default is hostname of this host.

(String) The directory where the Nova python modules are installed.

This directory is used to store template files for networking and remote console access. It is also the default path for other config options which need to persist Nova internal data. It is very unlikely that you need to change this option from its default value.

Possible values:

• The full path to a directory.

Related options:

• state_path

(String) Path to the rootwrap configuration file.

Goal of the root wrapper is to allow a service-specific unprivileged user to run a number of actions as the root user in the safest manner possible. The configuration file used here must match the one defined in the sudoers entry.

(String) The top-level directory for maintaining Nova’s state.

This directory is used to store Nova’s internal state. It is used by a variety of other config options which derive from this. In some scenarios (for example migrations) it makes sense to use a storage location which is shared between multiple compute hosts (for example via NFS). Unless the option instances_path gets overwritten, this directory can grow very large.

Possible values:

• The full path to a directory. Defaults to value provided in pybasedir.

(Boolean) Disable live snapshots when using the libvirt driver.

Live snapshots allow the snapshot of the disk to happen without an interruption to the guest, using coordination with a guest agent to quiesce the filesystem.

When using libvirt 1.2.2 live snapshots fail intermittently under load (likely related to concurrent libvirt/qemu operations). This config option provides a mechanism to disable live snapshot, in favor of cold snapshot, while this is resolved. Cold snapshot causes an instance outage while the guest is going through the snapshotting process.

For more information, refer to the bug report:

https://bugs.launchpad.net/nova/+bug/1334398

Possible values:

• True: Live snapshot is disabled when using libvirt
• False: Live snapshots are always used when snapshotting (as long as there is a new enough libvirt and the backend storage supports it)

(Boolean) Enable handling of events emitted from compute drivers.

Many compute drivers emit lifecycle events, which are events that occur when, for example, an instance is starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored.

This is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and that the instance can be shutdown automatically. Unfortunately, this can race in some conditions, for example in reboot operations or when the compute service or when host is rebooted (planned or due to an outage). If such races are common, then it is advisable to disable this feature.

Care should be taken when this feature is disabled and ‘sync_power_state_interval’ is set to a negative value. In this case, any instances that get out of sync between the hypervisor and the Nova database will have to be synchronized manually.

For more information, refer to the bug report:

https://bugs.launchpad.net/bugs/1444630

Interdependencies to other options:

• If sync_power_state_interval is negative and this feature is disabled, then instances that get out of sync between the hypervisor and the Nova database will have to be synchronized manually.

(String) DEPRECATED: Abstracts out managing compute host stats to pluggable class. This class manages and updates stats for the local compute host after an instance is changed. These configurable compute stats may be useful for a particular scheduler implementation.

Possible values

• A string representing fully qualified class name.

(String) Time period to generate instance usages for. It is possible to define optional offset to given period by appending @ character followed by a number defining offset.

Possible values:

• period, example: hour, day, month` or ``year
• period with offset, example: month@15 will result in monthly audits starting on 15th day of month.

(Integer) Limits the maximum number of instance builds to run concurrently by nova-compute. Compute service can attempt to build an infinite number of instances, if asked to do so. This limit is enforced to avoid building unlimited instance concurrently on a compute node. This value can be set per compute node.

Possible Values:

• 0 : treated as unlimited.
• Any positive integer representing maximum concurrent builds.

(Integer) Time interval after which an instance is hard rebooted automatically.

When doing a soft reboot, it is possible that a guest kernel is completely hung in a way that causes the soft reboot task to not ever finish. Setting this option to a time period in seconds will automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds.

Possible values:

• 0: Disables the option (default).
• Any positive integer in seconds: Enables the option.

(Integer) Interval to wait before un-rescuing an instance stuck in RESCUE.

Possible values:

• 0: Disables the option (default)
• Any positive integer in seconds: Enables the option.

(Integer) Time interval in seconds to wait between runs for the clean up action. If set to 0, above check will be disabled. If “running_deleted_instance _action” is set to “log” or “reap”, a value greater than 0 must be set.

Possible values:

• Any positive integer in seconds enables the option.
• 0: Disables the option.
• 1800: Default value.

Related options:

• running_deleted_instance_action

(Integer) Total time to wait in seconds for an instance toperform a clean shutdown.

It determines the overall period (in seconds) a VM is allowed to perform a clean shutdown. While performing stop, rescue and shelve, rebuild operations, configuring this option gives the VM a chance to perform a controlled shutdown before the instance is powered off. The default timeout is 60 seconds.

The timeout value can be overridden on a per image basis by means of os_shutdown_timeout that is an image metadata setting allowing different types of operating systems to specify how much time they need to shut down cleanly.

Possible values:

• Any positive integer in seconds (default value is 60).

(Integer) Number of greenthreads available for use to sync power states.

This option can be used to reduce the number of concurrent requests made to the hypervisor or system with real instance power states for performance reasons, for example, with Ironic.

Possible values:

• Any positive integer representing greenthreads count.

(Boolean) Determine if instance should boot or fail on VIF plugging timeout.

Nova sends a port update to Neutron after an instance has been scheduled, providing Neutron with the necessary information to finish setup of the port. Once completed, Neutron notifies Nova that it has finished setting up the port, at which point Nova resumes the boot of the instance since network connectivity is now supposed to be present. A timeout will occur if the reply is not received after a given interval.

This option determines what Nova does when the VIF plugging timeout event happens. When enabled, the instance will error out. When disabled, the instance will continue to boot on the assumption that the port is ready.

Possible values:

• True: Instances should fail after VIF plugging timeout
• False: Instances should continue booting after VIF plugging timeout

(Integer) Number of times to retry live-migration before failing.

Possible values:

• If == -1, try until out of hosts (default)
• If == 0, only try once, no retries
• Integer greater than 0

(String) DEPRECATED: Full class name for the Manager for conductor.

Removal in 14.0

(Boolean) DEPRECATED: Perform nova-conductor operations locally. This legacy mode was introduced to bridge a gap during the transition to the conductor service. It no longer represents a reasonable alternative for deployers.

Removal may be as early as 14.0.

(String) Configuration drive format

Configuration drive format that will contain metadata attached to the instance when it boots.

Possible values:

• iso9660: A file system image standard that is widely supported across operating systems. NOTE: Mind the libvirt bug (https://bugs.launchpad.net/nova/+bug/1246201) - If your hypervisor driver is libvirt, and you want live migrate to work without shared storage, then use VFAT.
• vfat: For legacy reasons, you can configure the configuration drive to use VFAT format instead of ISO 9660.

Related options:

• This option is meaningful when one of the following alternatives occur: 1. force_config_drive option set to ‘true’ 2. the REST API call to create the instance contains an enable flag for config drive option 3. the image used to create the instance requires a config drive, this is defined by img_config_drive property for that image.
• A compute node running Hyper-V hypervisor can be configured to attach configuration drive as a CD drive. To attach the configuration drive as a CD drive, set config_drive_cdrom option at hyperv section, to true.

(Boolean) Force injection to take place on a config drive

When this option is set to true configuration drive functionality will be forced enabled by default, otherwise user can still enable configuration drives via the REST API or image metadata properties.

Possible values:

• True: Force to use of configuration drive regardless the user’s input in the REST API call.
• False: Do not force use of configuration drive. Config drives can still be enabled via the REST API or image metadata properties.

Related options:

• Use the ‘mkisofs_cmd’ flag to set the path where you install the genisoimage program. If genisoimage is in same path as the nova-compute service, you do not need to set this flag.
• To use configuration drive with Hyper-V, you must set the ‘mkisofs_cmd’ value to the full path to an mkisofs.exe installation. Additionally, you must set the qemu_img_cmd value in the hyperv configuration section to the full path to an qemu-img command installation.

(Boolean) Configuration drive inject password

Enables setting the admin password in the configuration drive image.

Related options:

• This option is meaningful when used with other options that enable configuration drive usage with Hyper-V, such as force_config_drive.
• Currently, the only accepted config_drive_format is ‘iso9660’.

(List) Adds list of allowed origins to the console websocket proxy to allow connections from other origin hostnames. Websocket proxy matches the host header with the origin header to prevent cross-site requests. This list specifies if any there are values other than host are allowed in the origin header.

Possible values

• An empty list (default) or list of allowed origin hostnames.

(String) Location of MKS web console proxy

The URL in the response points to a WebMKS proxy which starts proxying between client and corresponding vCenter server where instance runs. In order to use the web based console access, WebMKS proxy should be installed and configured

Possible values:

• Must be a valid URL of the form:http://host:port/

(String) Filename of root CA (Certificate Authority). This is a container format and includes root certificates.

Possible values:

• Any file name containing root CA, cacert.pem is default

Related options:

• ca_path

(String) Filename of root Certificate Revocation List (CRL). This is a list of certificates that have been revoked, and therefore, entities presenting those (revoked) certificates should no longer be trusted.

Related options:

• ca_path

(String) Directory path where keys are located.

Related options:

• key_file

(Boolean) Enable/disables guestfs logging.

This configures guestfs to debug messages and push them to Openstack logging system. When set to True, it traces libguestfs API calls and enable verbose debug messages. In order to use the above feature, “libguestfs” package must be installed.

Related options: Since libguestfs access and modifies VM’s managed by libvirt, below options should be set to give access to those VM’s.

• libvirt.inject_key
• libvirt.inject_partition
• libvirt.inject_password

(String) Debug host (IP or name) to connect to. This command line parameter is used when you want to connect to a nova service via a debugger running on a different host.

Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk.

Possible Values:

• IP address of a remote host as a command line parameter to a nova service. For Example:

/usr/local/bin/nova-compute –config-file /etc/nova/nova.conf –remote_debug-host <IP address where the debugger is running>

(String) Cipher-mode string to be used

The cipher and mode to be used to encrypt ephemeral storage. The set of cipher-mode combinations available depends on kernel support.

Possible values:

• aes-xts-plain64 (Default), see /proc/crypto for available options.

(Integer) Encryption key length in bits

The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key).

(String) This string is prepended to the normal URL that is returned in links to Glance resources. If it is empty (the default), the URLs are returned unchanged.

Possible values:

• Any string, including an empty string (the default).

(Floating point) Dynamic memory ratio

Enables dynamic memory allocation (ballooning) when set to a value greater than 1. The value expresses the ratio between the total RAM assigned to an instance and its startup RAM amount. For example a ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of RAM allocated at startup.

Possible values:

• 1.0: Disables dynamic memory allocation (Default).
• Float values greater than 1.0: Enables allocation of total implied RAM divided by this value for startup.

(Boolean) Enable RemoteFX feature

This requires at least one DirectX 11 capable graphics adapter for Windows / Hyper-V Server 2012 R2 or newer and RDS-Virtualization feature has to be enabled.

Instances with RemoteFX can be requested with the following flavor extra specs:

os:resolution. Guest VM screen resolution size. Acceptable values:

1024x768, 1280x1024, 1600x1200, 1920x1200, 2560x1600, 3840x2160

3840x2160 is only available on Windows / Hyper-V Server 2016.

os:monitors. Guest VM number of monitors. Acceptable values:

[1, 4] - Windows / Hyper-V Server 2012 R2 [1, 8] - Windows / Hyper-V Server 2016

os:vram. Guest VM VRAM amount. Only available on Windows / Hyper-V Server 2016. Acceptable values:

64, 128, 256, 512, 1024

(Boolean) Limit CPU features

This flag is needed to support live migration to hosts with different CPU features and checked during instance creation in order to limit the CPU features used by the instance.

(Integer) Mounted disk query retry interval

Interval between checks for a mounted iSCSI disk, in seconds.

Possible values:

• Time in seconds (Default: 5).

Related options:

• This option is meaningful when the mounted_disk_query_retry_count is greater than 1.
• The retry loop runs with mounted_disk_query_retry_count and mounted_disk_query_retry_interval configuration options.

(Integer) Power state event polling interval

Instance power state change event polling frequency. Sets the listener interval for power state events to the given value. This option enhances the internal lifecycle notifications of instances that reboot themselves. It is unlikely that an operator has to change this value.

Possible values:

• Time in seconds (Default: 2).

(String) External virtual switch name

The Hyper-V Virtual Switch is a software-based layer-2 Ethernet network switch that is available with the installation of the Hyper-V server role. The switch includes programmatically managed and extensible capabilities to connect virtual machines to both virtual networks and the physical network. In addition, Hyper-V Virtual Switch provides policy enforcement for security, isolation, and service levels. The vSwitch represented by this config option must be an external one (not internal or private).

Possible values:

• If not provided, the first of a list of available vswitches is used. This list is queried using WQL.
• Virtual switch name.

(String) The default format an ephemeral_volume will be formatted with on creation.

Possible values:

• ext2
• ext3
• ext4
• xfs
• ntfs (only for Windows guests)

(String) Generic property to specify the pointer type.

Input devices allow interaction with a graphical framebuffer. For example to provide a graphic tablet for absolute cursor movement.

If set, the ‘hw_pointer_model’ image property takes precedence over this configuration option.

Possible values:

• None: Uses default behavior provided by drivers (mouse on PS2 for libvirt x86)
• ps2mouse: Uses relative movement. Mouse connected by PS2
• usbtablet: Uses absolute movement. Tablet connect by USB

Interdependencies to other options:

• usbtablet must be configured with VNC enabled or SPICE enabled and SPICE agent disabled. When used with libvirt the instance mode should be configured as HVM.

(String) Defines which physical CPUs (pCPUs) can be used by instance virtual CPUs (vCPUs).

Possible values:

• A comma-separated list of physical CPU numbers that virtual CPUs can be allocated to by default. Each element should be either a single CPU number, a range of CPU numbers, or a caret followed by a CPU number to be excluded from a previous range. For example:

vcpu_pin_set = “4-12,^8,15”

(Integer) The number of seconds to wait before retrying the request.

Related options:

• api_max_retries

(String) This option determines the fixed IPv6 address block when creating a network.

Please note that this option is only used when using nova-network instead of Neutron in your deployment.

Possible values:

Any valid IPv6 CIDR. The default value is “fd00::/48”.

Related options:

use_neutron

(String) Abstracts out IPv6 address generation to pluggable backends.

nova-network can be put into dual-stack mode, so that it uses both IPv4 and IPv6 addresses. In dual-stack mode, by default, instances acquire IPv6 global unicast addresses with the help of stateless address auto-configuration mechanism.

Related options:

• use_neutron: this option only works with nova-network.
• use_ipv6: this option only works if ipv6 is enabled for nova-network.

(String) Is used to set the CPU mode an instance should have.

If virt_type=”kvm|qemu”, it will default to “host-model”, otherwise it will default to “none”.

Possible values:

• host-model: Clones the host CPU feature flags.
• host-passthrough: Use the host CPU model exactly;
• custom: Use a named CPU model;
• none: Not set any CPU model.

Related options:

• cpu_model: If custom is used for cpu_mode, set this config option too, otherwise this would result in an error and the instance won’t be launched.

(List) This is a performance event list which could be used as monitor. These events will be passed to libvirt domain xml while creating a new instances. Then event statistics data can be collected from libvirt. The minimum libvirt version is 2.0.0. For more information about Performance monitoring events, refer https://libvirt.org/formatdomain.html#elementsPerf .

• Possible values: A string list. For example: enabled_perf_events = cmt, mbml, mbmt

The supported events list can be found in https://libvirt.org/html/libvirt-libvirt-domain.html , which you may need to search key words VIR_PERF_PARAM_*

• Services that use this:

nova-compute

• Related options: None

(Integer) Determines the way how the file system is chosen to inject data into it.

libguestfs will be used a first solution to inject data. If that’s not available on the host, the image will be locally mounted on the host as a fallback solution. If libguestfs is not able to determine the root partition (because there are more or less than one root partition) or cannot mount the file system it will result in an error and the instance won’t be boot.

Possible values:

• -2 => disable the injection of data.
• -1 => find the root partition with the file system to mount with libguestfs
• 0 => The image is not partitioned
• >0 => The number of the partition to use for the injection

Related options:

• inject_key: If this option allows the injection of a SSH key it depends on value greater or equal to -1 for inject_partition.
• inject_password: If this option allows the injection of an admin password it depends on value greater or equal to -1 for inject_partition.
• guestfs You can enable the debug log level of libguestfs with this config option. A more verbose output will help in debugging issues.
• virt_type: If you use lxc as virt_type it will be treated as a single partition image

(String) The ID of the kernel (AKI) image to use with the rescue image.

If the chosen rescue image allows the separate definition of its kernel disk, the value of this option is used, if specified. This is the case when Amazon‘s AMI/AKI/ARI image format is used for the rescue image.

Possible values:

• An ID of an kernel image or nothing. If nothing is specified, the kernel disk from the instance is used if it was launched with one.

Related options:

• rescue_image_id: If that option points to an image in Amazon‘s AMI/AKI/ARI image format, it’s useful to use rescue_kernel_id too.

(String) Path to vzstorage client log.

This option defines the log of cluster operations, it should include “%(cluster_name)s” template to separate logs from multiple shares.

• Services that use this:

nova-compute

• Related options:

vzstorage_mount_opts may include more detailed logging options.

(List) Extra mount options for pstorage-mount

For full description of them, see https://static.openvz.org/vz-man/man1/pstorage-mount.1.gz.html Format is a python string representation of arguments list, like: “[‘-v’, ‘-R’, ‘500’]” Shouldn’t include -c, -l, -C, -u, -g and -m as those have explicit vzstorage_* options.

• Services that use this:

nova-compute

• Related options:

All other vzstorage_* options

(String) Directory where the Virtuozzo Storage clusters are mounted on the compute node.

This option defines non-standard mountpoint for Vzstorage cluster.

• Services that use this:

nova-compute

• Related options:

vzstorage_mount_* group of parameters

(Integer) Maximum number of 1 second retries in live_migration. It specifies number of retries to iptables when it complains. It happens when an user continously sends live-migration request to same host leading to concurrent request to iptables.

Possible values:

• Any positive integer representing retry count.

(Integer) Time to wait, in seconds, for migration to successfully complete transferring data before aborting the operation. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB. Should usually be larger than downtime delay

• downtime steps. Set to 0 to disable timeouts.

Mutable

This option can be changed without restarting.

(Boolean) This option allows nova to switch an on-going live migration to post-copy mode, i.e., switch the active VM to the one on the destination node before the migration is complete, therefore ensuring an upper bound on the memory that needs to be transferred. Post-copy requires libvirt>=1.3.3 and QEMU>=2.5.0.

When permitted, post-copy mode will be automatically activated if a live-migration memory copy iteration does not make percentage increase of at least 10% over the last iteration.

The live-migration force complete API also uses post-copy when permitted. If post-copy mode is not available, force complete falls back to pausing the VM to ensure the live-migration operation will complete.

When using post-copy mode, if the source and destination hosts loose network connectivity, the VM being live-migrated will need to be rebooted. For more details, please see the Administration guide.

Related options:

• live_migration_permit_auto_converge

(Integer) Maximum wait time for an external REST service to connect.

Possible values:

• Any integer with a value greater than three (the TCP packet retransmission timeout). Note that instance start may be blocked during this wait time, so this value should be kept small.

Related options:

• vendordata_providers
• vendordata_dynamic_targets
• vendordata_dynamic_ssl_certfile
• vendordata_dynamic_read_timeout

(String) Path to an optional certificate file or CA bundle to verify dynamic vendordata REST services ssl certificates against.

Possible values:

• An empty string, or a path to a valid certificate file

Related options:

• vendordata_providers
• vendordata_dynamic_targets
• vendordata_dynamic_connect_timeout
• vendordata_dynamic_read_timeout

(String) Cloud providers may store custom data in vendor data file that will then be available to the instances via the metadata service, and to the rendering of config-drive. The default class for this, JsonFileVendorData, loads this information from a JSON file, whose path is configured by this option. If there is no path set by this option, the class returns an empty dictionary.

Possible values:

• Any string representing the path to the data file, or an empty string (default).

(Boolean) Determine whether to allow network traffic from same network.

When set to true, hosts on the same subnet are not filtered and are allowed to pass all types of traffic between them. On a flat network, this allows all instances from all projects unfiltered communication. With VLAN networking, this allows access between instances within the same project.

This option only applies when using the nova-network service. When using another networking services, such as Neutron, security groups or other approaches should be used.

Possible values:

• True: Network traffic should be allowed pass between all instances on the same network, regardless of their tenant and security policies
• False: Network traffic should not be allowed pass between instances unless it is unblocked in a security group

Interdependencies to other options:

• use_neutron: This must be set to False to enable nova-network networking
• firewall_driver: This must be set to nova.virt.libvirt.firewall.IptablesFirewallDriver to ensure the libvirt firewall driver is enabled.

(Integer) This option represents the number of IP addresses to reserve at the top of the address range for VPN clients. It also will be ignored if the configuration option for network_manager is not set to the default of ‘nova.network.manager.VlanManager’.

Possible values:

Any integer, 0 or greater. The default is 0.

Related options:

use_neutron, network_manager

(String) Name of the network to be used to set access IPs for instances. If there are multiple IPs to choose from, an arbitrary one will be chosen.

Possible values:

• None (default)
• Any string representing network name.

(Integer) The lifetime of a DHCP lease, in seconds. The default is 86400 (one day).

Possible values:

Any positive integer value.

(Multi-valued) This option is a list of full paths to one or more configuration files for dhcpbridge. In most cases the default path of ‘/etc/nova/nova-dhcpbridge.conf’ should be sufficient, but if you have special needs for configuring dhcpbridge, you can change or add to this list.

Possible values

A list of strings, where each string is the full path to a dhcpbridge configuration file.

(Integer) This option determines the time, in seconds, to wait between refreshing DNS entries for the network.

Possible values:

Either -1 (default), or any positive integer. A negative value will disable the updates.

Related options:

use_neutron

(Integer) This option determines the number of times to retry ebtables commands before giving up. The minimum number of retries is 1.

Possible values:

• Any positive integer

Related options:

• ebtables_retry_interval

(String) Firewall driver to use with nova-network service.

This option only applies when using the nova-network service. When using another networking services, such as Neutron, this should be to set to the nova.virt.firewall.NoopFirewallDriver.

If unset (the default), this will default to the hypervisor-specified default driver.

Possible values:

• nova.virt.firewall.IptablesFirewallDriver
• nova.virt.firewall.NoopFirewallDriver
• nova.virt.libvirt.firewall.IptablesFirewallDriver
• [...]

Interdependencies to other options:

• use_neutron: This must be set to False to enable nova-network networking

(String) This option determines the bridge used for simple network interfaces when no bridge is specified in the VM creation request.

Please note that this option is only used when using nova-network instead of Neutron in your deployment.

Possible values:

Any string representing a valid network bridge, such as ‘br100’

Related options:

use_neutron

(String) Full class name for the DNS Manager for floating IPs.

This option specifies the class of the driver that provides functionality to manage DNS entries associated with floating IPs.

When a user adds a DNS entry for a specified domain to a floating IP, nova will add a DNS entry using the specified floating DNS driver. When a floating IP is deallocated, its DNS entry will automatically be deleted.

Possible values:

• Full Python path to the class to be used

(Multi-valued) This is a list of zero or more IP ranges that traffic from the routing_source_ip will be SNATted to. If the list is empty, then no SNAT rules are created.

Possible values:

A list of strings, each of which should be a valid CIDR.

Related options:

routing_source_ip

(String) This is the default IPv4 gateway. It is used only in the testing suite.

Please note that this option is only used when using nova-network instead of Neutron in your deployment.

Possible values:

Any valid IP address.

Related options:

use_neutron, gateway_v6

(String) This expression, if defined, will select any matching iptables rules and place them at the bottom when applying metadata changes to the rules.

Possible values:

• Any string representing a valid regular expression, or an empty string

Related options:

• iptables_top_regex

(String) This expression, if defined, will select any matching iptables rules and place them at the top when applying metadata changes to the rules.

Possible values:

• Any string representing a valid regular expression, or an empty string

Related options:

• iptables_bottom_regex

(String) This is the class used as the ethernet device driver for linuxnet bridge operations. The default value should be all you need for most cases, but if you wish to use a customized class, set this option to the full dot-separated import path for that class.

Possible values:

Any string representing a dot-separated class path that Nova can import.

(Integer) This option determines the number of addresses in each private subnet.

Please note that this option is only used when using nova-network instead of Neutron in your deployment.

Possible values:

Any positive integer that is less than or equal to the available network size. Note that if you are creating multiple networks, they must all fit in the available IP address space. The default is 256.

Related options:

use_neutron, num_networks

(String) The location where the network configuration files will be kept. The default is the ‘networks’ directory off of the location where nova’s Python module is installed.

Possible values

A string containing the full path to the desired configuration directory

(Integer) This option represents the period of time, in seconds, that the ovs_vsctl calls will wait for a response from the database before timing out. A setting of 0 means that the utility should wait forever for a response.

Possible values:

• Any positive integer if a limited timeout is desired, or zero if the calls should wait forever for a response.

(String) This is the public IP address of the network host. It is used when creating a SNAT rule.

Possible values:

Any valid IP address

Related options:

force_snat_range

(Integer) When arp messages are configured to be sent, they will be sent with the count set to the value of this option. Of course, if this is set to zero, no arp messages will be sent.

Possible values:

Any integer greater than or equal to 0

Related options:

send_arp_for_ha

(Boolean) Determines whether unused gateway devices, both VLAN and bridge, are deleted if the network is in nova-network VLAN mode and is multi-hosted.

Related options:

use_neutron, vpn_ip, fake_network

(Boolean) When this option is set to True, the dns1 and dns2 servers for the network specified by the user on boot will be used for DNS, as well as any specified in the dns_server option.

Related options:

dns_server

(Boolean) When True, the TenantNetworkController will query the Neutron API to get the default networks to use.

Related options:

• neutron_default_tenant_id

(String) This option is the name of the virtual interface of the VM on which the VLAN bridge will be built. While it was originally designed to be used only by nova-network, it is also used by libvirt and xenapi for the bridge interface name.

Please note that this setting will be ignored in nova-network if the configuration option for network_manager is not set to the default of ‘nova.network.manager.VlanManager’.

Possible values:

Any valid virtual interface name, such as ‘eth0’

(String) Tenant ID for getting the default network from Neutron API (also referred in some places as the ‘project ID’) to use.

Related options:

• use_neutron_default_nets

(String) Specifies the name of an integration bridge interface used by OpenvSwitch. This option is used only if Neutron does not specify the OVS bridge name.

Possible values:

• Any string representing OVS bridge name.

(Boolean) When set to True, this option indicates that Neutron will be used to proxy metadata requests and resolve instance ids. Otherwise, the instance ID must be passed to the metadata request in the ‘X-Instance-ID’ header.

Related options:

• metadata_proxy_shared_secret

(URI) This option specifies the URL for connecting to Neutron.

Possible values:

• Any valid URL that points to the Neutron API service is appropriate here. This typically matches the URL returned for the ‘network’ service type from the Keystone service catalog.

(Multi-valued) An alias for a PCI passthrough device requirement.

This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements.

Possible Values:

• A list of JSON values which describe the aliases. For example:

pci_alias = { “name”: “QuickAssist”, “product_id”: “0443”, “vendor_id”: “8086”, “device_type”: “type-PCI” }

defines an alias for the Intel QuickAssist card. (multi valued). Valid key values are :

• “name”: Name of the PCI alias.
• “product_id”: Product ID of the device in hexadecimal.
• “vendor_id”: Vendor ID of the device in hexadecimal.
• “device_type”: Type of PCI device. Valid values are: “type-PCI”, “type-PF” and “type-VF”.

(Integer) The number of seconds between subsequent usage refreshes. This defaults to 0 (off) to avoid additional load but it is useful to turn on to help keep quota usage up-to-date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation.

Possible values:

• 0 (default) or any positive integer representing number of seconds.

(String) Sets the scope of the check for unique instance names.

The default doesn’t check for unique names. If a scope for the name check is set, a launch of a new instance or an update of an existing instance with a duplicate name will result in an ‘’InstanceExists’’ error. The uniqueness is case-insensitive. Setting this option can increase the usability for end users as they don’t have to distinguish among instances with the same name by their IDs.

Possible values:

• ‘’: An empty value means that no uniqueness check is done and duplicate names are possible.
• “project”: The instance name check is done only for instances within the same project.
• “global”: The instance name check is done for all instances regardless of the project.

(Integer) The number of instance cores or VCPUs allowed per project.

Possible values:

• 20 (default) or any positive integer.
• -1 : treated as unlimited.

(Integer) The number of fixed IPs allowed per project (this should be at least the number of instances allowed). Unlike floating IPs, fixed IPs are allocated dynamically by the network component when instances boot up.

Possible values:

• -1 (default) : treated as unlimited.
• Any positive integer.

(Integer) The number of bytes allowed per injected file.

Possible values:

• 10240 (default) or any positive integer representing number of bytes.
• -1 : treated as unlimited.

(Integer) The number of injected files allowed. It allow users to customize the personality of an instance by injecting data into it upon boot. Only text file injection is permitted. Binary or zip files won’t work. During file injection, any existing files that match specified files are renamed to include .bak extension appended with a timestamp.

Possible values:

• 5 (default) or any positive integer.
• -1 : treated as unlimited.

(Integer) The maximum number of key pairs allowed per user. Users can create at least one key pair for each project and use the key pair for multiple instances that belong to that project.

Possible values:

• 100 (default) or any positive integer.
• -1 : treated as unlimited.

(Integer) DEPRECATED: This option controls the number of private networks that can be created per project (or per tenant).

Related options:

• enable_network_quota CRUD operations on tenant networks are only available when using nova-network and nova-network is itself deprecated.

(Integer) The number of security rules per security group. The associated rules in each security group control the traffic to instances in the group.

Possible values:

• 20 (default) or any positive integer.
• -1 : treated as unlimited.

(Integer) Add quota values to constrain the number of servers per server group.

Possible values:

• 10 (default) or any positive integer.
• -1 : treated as unlimited.

(Boolean) Enable Remote Desktop Protocol (RDP) related features.

Hyper-V, unlike the majority of the hypervisors employed on Nova compute nodes, uses RDP instead of VNC and SPICE as a desktop sharing protocol to provide instance console access. This option enables RDP for graphical console access for virtual machines created by Hyper-V.

Note: RDP should only be enabled on compute nodes that support the Hyper-V virtualization platform.

Related options:

• compute_driver: Must be hyperv.

(String) The URL an end user would use to connect to the nova-serialproxy service.

The nova-serialproxy service is called with this token enriched URL and establishes the connection to the proper instance.

Possible values:

• <scheme><IP-address><port-number>

Services which consume this:

• nova-compute

Interdependencies to other options:

• The IP address must be identical to the address to which the nova-serialproxy service is listening (see option serialproxy_host in this section).
• The port must be the same as in the option serialproxy_port of this section.
• If you choose to use a secured websocket connection, then start this option with wss:// instead of the unsecured ws://. The options cert and key in the [DEFAULT] section have to be set for that.

(String) A range of TCP ports a guest can use for its backend.

Each instance which gets created will use one port out of this range. If the range is not big enough to provide another port for an new instance, this instance won’t get launched.

Possible values:

Each string which passes the regex \d+:\d+ For example 10000:20000. Be sure that the first port number is lower than the second port number.

Services which consume this:

• nova-compute

Interdependencies to other options:

• None

(String) The IP address which is used by the nova-serialproxy service to listen for incoming requests.

The nova-serialproxy service listens on this IP address for incoming connection requests to instances which expose serial console.

Possible values:

• An IP address

Services which consume this:

• nova-serialproxy

Interdependencies to other options:

• Ensure that this is the same IP address which is defined in the option base_url of this section or use 0.0.0.0 to listen on all addresses.

(List) List of modules/decorators to monkey patch.

This option allows you to patch a decorator for all functions in specified modules.

Possible values:

• nova.compute.api:nova.notifications.notify_decorator
• nova.api.ec2.cloud:nova.notifications.notify_decorator
• [...]

Related options:

• monkey_patch: This must be set to True for this option to have any effect

(String) The URL on the attestation server to use. See the attestation_server help text for more information about host verification.

This value must be just that path portion of the full URL, as it will be joined to the host specified in the attestation_server option.

This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the ‘TrustedFilter’ filter is enabled.

• Related options:

attestation_server attestation_server_ca_file attestation_port attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl

(Integer) This value controls how long a successful attestation is cached. Once this period has elapsed, a new attestation request will be made. See the attestation_server help text for more information about host verification.

The value is in seconds. Valid values must be positive integers for any caching; setting this to zero or a negative value will result in calls to the attestation_server for every request, which may impact performance.

This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the ‘TrustedFilter’ filter is enabled.

• Related options:

attestation_server attestation_server_ca_file attestation_port attestation_api_url attestation_auth_blob attestation_insecure_ssl

(String) The port to use when connecting to the attestation server. See the attestation_server help text for more information about host verification.

Valid values are strings, not integers, but must be digits only.

This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the ‘TrustedFilter’ filter is enabled.

• Related options:

attestation_server attestation_server_ca_file attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl

(String) The absolute path to the certificate to use for authentication when connecting to the attestation server. See the attestation_server help text for more information about host verification.

The value is a string, and must point to a file that is readable by the scheduler.

This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. Also note that this setting only affects scheduling if the ‘TrustedFilter’ filter is enabled.

• Related options:

attestation_server attestation_port attestation_api_url attestation_auth_blob attestation_auth_timeout attestation_insecure_ssl

(String) Cells scheduler

The class of the driver used by the cells scheduler. This should be the full Python path to the class to be used. If nothing is specified in this option, the CellsScheduler is used.

(String) Specifies the maximum version for messages sent from cert services. This should be the minimum value that is supported by all of the deployed cert services.

Possible values:

Any valid OpenStack release name, in lower case, such as ‘mitaka’ or ‘liberty’. Alternatively, it can be any string representing a version number in the format ‘N.N’; for example, possible values might be ‘1.12’ or ‘2.0’.

Services which consume this:

• nova-cert

Related options:

• None

(String) This option adds a prefix to the folder where cached images are stored

This is not the full path - just a folder prefix. This should only be used when a datastore cache is shared between compute nodes.

Note: This should only be used when the compute nodes are running on same host or they have a shared file system.

Possible values:

• Any string representing the cache prefix to the folder

(Boolean) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification.

Related options:

• ca_file: This option is ignored if “ca_file” is set.

(Integer) This option specifies the limit on the maximum number of objects to return in a single result.

A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified limit. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.

(Boolean) This option enables or disables storage policy based placement of instances.

Related options:

• pbm_default_policy

(String) Identifies a proxy service that provides network access to the serial_port_service_uri.

Possible values:

• Any valid URI

Related options: This option is ignored if serial_port_service_uri is not specified.

• serial_port_service_uri

(String) This option specifies VIM Service WSDL Location

If vSphere API versions 5.1 and later is being used, this section can be ignored. If version is less than 5.1, WSDL files must be hosted locally and their location must be specified in the above section.

Optional over-ride to default location for bug work-arounds.

Possible values:

• http://<server>/vimService.wsdl
• file:///opt/stack/vmware/SDK/wsdl/vim25/vimService.wsdl

(Boolean) Enable VNC related features.

Guests will get created with graphical devices to support this. Clients (for example Horizon) can then establish a VNC connection to the guest.

(URI) Public address of noVNC VNC console proxy.

The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client.

This option sets the public base URL to which client systems will connect. noVNC clients can use this address to connect to the noVNC instance and, by extension, the VNC sessions.

Related options:

• novncproxy_host
• novncproxy_port

(Port number) Port that the noVNC console proxy should bind to.

The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. noVNC provides VNC support through a websocket-based client.

This option sets the private port to which the noVNC console proxy service should bind to.

Related options:

• novncproxy_host
• novncproxy_base_url

(String) Private, internal IP address or hostname of VNC console proxy.

The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients.

This option sets the private address to which proxy clients, such as nova-xvpvncproxy, should connect to.

(String) IP address or hostname that the XVP VNC console proxy should bind to.

The VNC proxy is an OpenStack component that enables compute service users to access their instances through VNC clients. Xen provides the Xenserver VNC Proxy, or XVP, as an alternative to the websocket-based noVNC proxy used by Libvirt. In contrast to noVNC, XVP clients are Java-based.

This option sets the private address to which the XVP VNC console proxy service should bind to.

Related options:

• xvpvncproxy_port
• xvpvncproxy_base_url

(Integer) Number of times to retry block device allocation on failures. Starting with Liberty, Cinder can use image volume cache. This may help with block device allocation performance. Look at the cinder image_volume_cache_enabled configuration option.

Possible values:

• 60 (default)
• If value is 0, then one attempt is made.
• Any negative value is treated as 0.
• For any value > 0, total attempts are (value + 1)

(String) The IP address which is used to connect to the block storage network.

Possible values:

• String with valid IP address. Default is IP address of this host.

Related options:

• my_ip - if my_block_storage_ip is not set, then my_ip value is used.

(String) Info to match when looking for cinder in the service catalog.

Possible values:

• Format is separated values of the form: <service_type>:<service_name>:<endpoint_type>

Related options:

• endpoint_template - Setting this option will override catalog_info

(Boolean) Allow attach between instance and volume in different availability zones.

If False, volumes attached to an instance must be in the same availability zone in Cinder as the instance availability zone in Nova. This also means care should be taken when booting an instance from a volume where source is not “volume” because Nova will attempt to create a volume using the same availability zone as what is assigned to the instance. If that AZ is not in Cinder (or allow_availability_zone_fallback=False in cinder.conf), the volume create request will fail and the instance will fail the build request. By default there is no availability zone restriction on volume attach.

(Integer) Number of times cinderclient should retry on any failed http call. 0 means connection is attempted only once. Setting it to any positive integer means that on failure connection is retried that many times e.g. setting it to 3 means total attempts to connect will be 4.

Possible values:

• Any integer value. 0 means connection is attempted only once

(Integer) Volume attach retry interval

Interval between volume attachment attempts, in seconds.

Possible values:

• Time in seconds (Default: 5).

Related options:

• This options is meaningful when volume_attach_retry_count is greater than 1.
• The retry loop runs with volume_attach_retry_count and volume_attach_retry_interval configuration options.

(List) This option is a list of zero or more IP address ranges in your network’s DMZ that should be accepted.

Possible values:

A list of strings, each of which should be a valid CIDR.

(Port number) This is the port number to use as the first VPN port for private networks.

Please note that this option is only used when using nova-network instead of Neutron in your deployment. It also will be ignored if the configuration option for network_manager is not set to the default of ‘nova.network.manager.VlanManager’, or if you specify a value the ‘vpn_start’ parameter when creating a network.

Possible values:

Any integer representing a valid port number. The default is 1000.

Related options:

use_neutron, vpn_ip, network_manager

(String) This option represents a file name for the paste.deploy config for nova-api.

Possible values:

• A string representing file name for the paste.deploy config.

(Integer) This option specifies the maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).

Since TCP is a stream based protocol, in order to reuse a connection, the HTTP has to have a way to indicate the end of the previous response and beginning of the next. Hence, in a keep_alive case, all messages must have a self-defined message length.

(String) This option allows setting path to the CA certificate file that should be used to verify connecting clients.

Possible values:

• String representing path to the CA certificate file.

Related options:

• enabled_ssl_apis

(String) This option specifies the path to the file where SSL private key of API server is stored when SSL is in effect.

Possible values:

• String representing path to the SSL private key.

Related options:

• enabled_ssl_apis

(String) It represents a python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

This option is used for building custom request loglines.

Possible values:

• ‘%(client_ip)s “%(request_line)s” status: %(status_code)s’ ‘len: %(body_length)s time: %(wall_seconds).7f’ (default)
• Any formatted string formed by specific values.

(String) Nova-console proxy is used to set up multi-tenant VM console access. This option allows pluggable driver program for the console session and represents driver to use for the console proxy.

Possible values

• ‘nova.console.xvp.XVPConsoleProxy’ (default) or a string representing fully classified class name of console driver.

(String) Path to locate guest agent on the server.

Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image.

Related options: For this option to have an effect:

• flat_injected should be set to True
• compute_driver should be set to xenapi.XenAPIDriver

(Integer) Number of seconds to wait for agent’s reply to a request.

Nova configures/performs certain administrative actions on a server with the help of an agent that’s installed on the server. The communication between Nova and the agent is achieved via sharing messages, called records, over xenstore, a shared storage across all the domains on a Xenserver host. Operations performed by the agent on behalf of nova are: ‘version’,’ key_init’, ‘password’,’resetnetwork’,’inject_file’, and ‘agentupdate’.

To perform one of the above operations, the xapi ‘agent’ plugin writes the command and its associated parameters to a certain location known to the domain and awaits response. On being notified of the message, the agent performs appropriate actions on the server and writes the result back to xenstore. This result is then read by the xapi ‘agent’ plugin to determine the success/failure of the operation.

This config option determines how long the xapi ‘agent’ plugin shall wait to read the response off of xenstore for a given request/command. If the agent on the instance fails to write the result in this time period, the operation is considered to have timed out.

Related options:

• agent_version_timeout
• agent_resetnetwork_timeout

(String) Cache glance images locally.

The value for this option must be choosen from the choices listed here. Configuring a value other than these will default to ‘all’.

Note: There is nothing that deletes these images.

Possible values:

• all: will cache all images.
• some: will only cache images that have the image_property cache_in_nova=True.
• none: turns off caching entirely.

(String) URL for connection to XenServer/Xen Cloud Platform. A special value of unix://local can be used to connect to the local unix socket.

Possible values:

• Any string that represents a URL. The connection_url is generally the management network IP address of the XenServer.
• This option must be set if you chose the XenServer driver.

(Integer) Compression level for images.

By setting this option we can configure the gzip compression level. This option sets GZIP environment variable before spawning tar -cz to force the compression level. It defaults to none, which means the GZIP environment variable is not set and the default (usually -6) is used.

Possible values:

• Range is 1-9, e.g., 9 for gzip -9, 9 being most compressed but most CPU intensive on dom0.
• Any values out of this range will default to None.

(Boolean) Used to prevent attempts to attach VBDs locally, so Nova can be run in a VM on a different host.

Related options:

• CONF.flat_injected (Must be False)
• CONF.xenserver.check_host (Must be False)
• CONF.default_ephemeral_format (Must be unset or ‘ext3’)
• Joining host aggregates (will error if attempted)
• Swap disks for Windows VMs (will error if attempted)
• Nova-based auto_configure_disk (will error if attempted)

(String) URL to the iPXE boot menu.

An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image.

By default this option is not set. Enable this option to boot an iPXE ISO.

Related Options:

• ipxe_network_name
• ipxe_mkisofs_cmd

(String) Name of network to use for booting iPXE ISOs.

An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image.

By default this option is not set. Enable this option to boot an iPXE ISO.

Related Options:

• ipxe_boot_menu_url
• ipxe_mkisofs_cmd

(Integer) Maximum size in bytes of kernel or ramdisk images.

Specifying the maximum size of kernel or ramdisk will avoid copying large files to dom0 and fill up /boot/guest.

(String) The name of the integration Bridge that is used with xenapi when connecting with Open vSwitch.

Note: The value of this config option is dependent on the environment, therefore this configuration value must be set accordingly if you are using XenAPI.

Possible options:

• Any string that represents a bridge name(default is xapi1).

(String) Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb).

Related options:

• If remap_vbd_dev is set to False this option has no impact.

(String) Filter for finding the SR to be used to install guest instances on.

Possible values:

• To use the Local Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage.
• To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true.
• To fall back on the Default SR, as displayed by XenCenter, set this flag to: default-sr:true.

(String) The iSCSI Target Port.

This option represents the port of the iSCSI Target. If the target port is not present in the connection information from the volume provider then the value from this option is taken.

(Boolean) Whether or not to use the agent by default when its usage is enabled but not indicated by the image.

The use of XenAPI agent can be disabled altogether using the configuration option disable_agent. However, if it is not disabled, the use of an agent can still be controlled by the image in use through one of its properties, xenapi_use_agent. If this property is either not present or specified incorrectly on the image, the use of agent is determined by this configuration option.

Note that if this configuration is set to True when the agent is not present, the boot times will increase significantly.

Related options:

• disable_agent

(Integer) Max number of times to poll for VHD to coalesce.

This option determines the maximum number of attempts that can be made for coalescing the VHD before giving up.

Related opitons:

• vhd_coalesce_poll_interval