deprecated_options: DATABASE: - name: sql_connection replacement_group: database replacement_name: connection - name: sql_idle_timeout replacement_group: database replacement_name: idle_timeout - name: sql_min_pool_size replacement_group: database replacement_name: min_pool_size - name: sql_max_pool_size replacement_group: database replacement_name: max_pool_size - name: sql_max_retries replacement_group: database replacement_name: max_retries - name: reconnect_interval replacement_group: database replacement_name: retry_interval - name: sqlalchemy_max_overflow replacement_group: database replacement_name: max_overflow - name: sqlalchemy_pool_timeout replacement_group: database replacement_name: pool_timeout DEFAULT: - name: ssl_ca_file replacement_group: ssl replacement_name: ca_file - name: ssl_cert_file replacement_group: ssl replacement_name: cert_file - name: ssl_key_file replacement_group: ssl replacement_name: key_file - name: disable_process_locking replacement_group: oslo_concurrency replacement_name: disable_process_locking - name: lock_path replacement_group: oslo_concurrency replacement_name: lock_path - name: policy_file replacement_group: oslo_policy replacement_name: policy_file - name: policy_default_rule replacement_group: oslo_policy replacement_name: policy_default_rule - name: policy_dirs replacement_group: oslo_policy replacement_name: policy_dirs - name: amqp_durable_queues replacement_group: oslo_messaging_rabbit replacement_name: amqp_durable_queues - name: rabbit_durable_queues replacement_group: oslo_messaging_rabbit replacement_name: amqp_durable_queues - name: amqp_auto_delete replacement_group: oslo_messaging_rabbit replacement_name: amqp_auto_delete - name: kombu_reconnect_delay replacement_group: oslo_messaging_rabbit replacement_name: kombu_reconnect_delay - name: rabbit_host replacement_group: oslo_messaging_rabbit replacement_name: rabbit_host - name: rabbit_port replacement_group: oslo_messaging_rabbit replacement_name: rabbit_port - name: rabbit_hosts replacement_group: oslo_messaging_rabbit replacement_name: rabbit_hosts - name: rabbit_userid replacement_group: oslo_messaging_rabbit replacement_name: rabbit_userid - name: rabbit_password replacement_group: oslo_messaging_rabbit replacement_name: rabbit_password - name: rabbit_login_method replacement_group: oslo_messaging_rabbit replacement_name: rabbit_login_method - name: rabbit_virtual_host replacement_group: oslo_messaging_rabbit replacement_name: rabbit_virtual_host - name: rabbit_retry_backoff replacement_group: oslo_messaging_rabbit replacement_name: rabbit_retry_backoff - name: rabbit_max_retries replacement_group: oslo_messaging_rabbit replacement_name: rabbit_max_retries - name: rabbit_ha_queues replacement_group: oslo_messaging_rabbit replacement_name: rabbit_ha_queues - name: fake_rabbit replacement_group: oslo_messaging_rabbit replacement_name: fake_rabbit - name: quota_instances replacement_group: quota replacement_name: instances - name: quota_cores replacement_group: quota replacement_name: cores - name: quota_ram replacement_group: quota replacement_name: ram - name: quota_floating_ips replacement_group: quota replacement_name: floating_ips - name: quota_fixed_ips replacement_group: quota replacement_name: fixed_ips - name: quota_metadata_items replacement_group: quota replacement_name: metadata_items - name: quota_injected_files replacement_group: quota replacement_name: injected_files - name: quota_injected_file_content_bytes replacement_group: quota replacement_name: injected_file_content_bytes - name: quota_injected_file_path_length replacement_group: quota replacement_name: injected_file_path_length - name: quota_security_groups replacement_group: quota replacement_name: security_groups - name: quota_security_group_rules replacement_group: quota replacement_name: security_group_rules - name: quota_key_pairs replacement_group: quota replacement_name: key_pairs - name: quota_server_groups replacement_group: quota replacement_name: server_groups - name: quota_server_group_members replacement_group: quota replacement_name: server_group_members - name: reservation_expire replacement_group: quota replacement_name: reservation_expire - name: until_refresh replacement_group: quota replacement_name: until_refresh - name: max_age replacement_group: quota replacement_name: max_age - name: quota_driver replacement_group: quota replacement_name: driver - name: sqlite_synchronous replacement_group: database replacement_name: sqlite_synchronous - name: db_backend replacement_group: database replacement_name: backend - name: sql_connection replacement_group: database replacement_name: connection - name: sql_idle_timeout replacement_group: database replacement_name: idle_timeout - name: sql_min_pool_size replacement_group: database replacement_name: min_pool_size - name: sql_max_pool_size replacement_group: database replacement_name: max_pool_size - name: sql_max_retries replacement_group: database replacement_name: max_retries - name: sql_retry_interval replacement_group: database replacement_name: retry_interval - name: sql_max_overflow replacement_group: database replacement_name: max_overflow - name: sql_connection_debug replacement_group: database replacement_name: connection_debug - name: sql_connection_trace replacement_group: database replacement_name: connection_trace - name: dbapi_use_tpool replacement_group: database replacement_name: use_tpool - name: rpc_conn_pool_size replacement_group: DEFAULT replacement_name: rpc_conn_pool_size - name: rpc_zmq_bind_address replacement_group: DEFAULT replacement_name: rpc_zmq_bind_address - name: rpc_zmq_matchmaker replacement_group: DEFAULT replacement_name: rpc_zmq_matchmaker - name: rpc_zmq_contexts replacement_group: DEFAULT replacement_name: rpc_zmq_contexts - name: rpc_zmq_topic_backlog replacement_group: DEFAULT replacement_name: rpc_zmq_topic_backlog - name: rpc_zmq_ipc_dir replacement_group: DEFAULT replacement_name: rpc_zmq_ipc_dir - name: rpc_zmq_host replacement_group: DEFAULT replacement_name: rpc_zmq_host - name: rpc_cast_timeout replacement_group: DEFAULT replacement_name: zmq_linger - name: rpc_poll_timeout replacement_group: DEFAULT replacement_name: rpc_poll_timeout - name: zmq_target_expire replacement_group: DEFAULT replacement_name: zmq_target_expire - name: zmq_target_update replacement_group: DEFAULT replacement_name: zmq_target_update - name: use_pub_sub replacement_group: DEFAULT replacement_name: use_pub_sub - name: use_router_proxy replacement_group: DEFAULT replacement_name: use_router_proxy - name: rpc_zmq_min_port replacement_group: DEFAULT replacement_name: rpc_zmq_min_port - name: rpc_zmq_max_port replacement_group: DEFAULT replacement_name: rpc_zmq_max_port - name: rpc_zmq_bind_port_retries replacement_group: DEFAULT replacement_name: rpc_zmq_bind_port_retries - name: rpc_zmq_serialization replacement_group: DEFAULT replacement_name: rpc_zmq_serialization - name: rpc_thread_pool_size replacement_group: DEFAULT replacement_name: executor_thread_pool_size - name: log_config replacement_group: DEFAULT replacement_name: log-config-append - name: logfile replacement_group: DEFAULT replacement_name: log-file - name: logdir replacement_group: DEFAULT replacement_name: log-dir - name: notification_driver replacement_group: oslo_messaging_notifications replacement_name: driver - name: notification_transport_url replacement_group: oslo_messaging_notifications replacement_name: transport_url - name: notification_topics replacement_group: oslo_messaging_notifications replacement_name: topics - name: ca_file replacement_group: crypto replacement_name: ca_file - name: key_file replacement_group: crypto replacement_name: key_file - name: crl_file replacement_group: crypto replacement_name: crl_file - name: keys_path replacement_group: crypto replacement_name: keys_path - name: ca_path replacement_group: crypto replacement_name: ca_path - name: use_project_ca replacement_group: crypto replacement_name: use_project_ca - name: user_cert_subject replacement_group: crypto replacement_name: user_cert_subject - name: project_cert_subject replacement_group: crypto replacement_name: project_cert_subject - name: scheduler_host_subset_size replacement_group: filter_scheduler replacement_name: host_subset_size - name: max_io_ops_per_host replacement_group: filter_scheduler replacement_name: max_io_ops_per_host - name: max_instances_per_host replacement_group: filter_scheduler replacement_name: max_instances_per_host - name: scheduler_tracks_instance_changes replacement_group: filter_scheduler replacement_name: track_instance_changes - name: scheduler_available_filters replacement_group: filter_scheduler replacement_name: available_filters - name: scheduler_default_filters replacement_group: filter_scheduler replacement_name: enabled_filters - name: baremetal_scheduler_default_filters replacement_group: filter_scheduler replacement_name: baremetal_enabled_filters - name: scheduler_use_baremetal_filters replacement_group: filter_scheduler replacement_name: use_baremetal_filters - name: scheduler_weight_classes replacement_group: filter_scheduler replacement_name: weight_classes - name: ram_weight_multiplier replacement_group: filter_scheduler replacement_name: ram_weight_multiplier - name: disk_weight_multiplier replacement_group: filter_scheduler replacement_name: disk_weight_multiplier - name: io_ops_weight_multiplier replacement_group: filter_scheduler replacement_name: io_ops_weight_multiplier - name: soft_affinity_weight_multiplier replacement_group: filter_scheduler replacement_name: soft_affinity_weight_multiplier - name: soft_anti_affinity_weight_multiplier replacement_group: filter_scheduler replacement_name: soft_anti_affinity_weight_multiplier - name: isolated_images replacement_group: filter_scheduler replacement_name: isolated_images - name: isolated_hosts replacement_group: filter_scheduler replacement_name: isolated_hosts - name: restrict_isolated_hosts_to_isolated_images replacement_group: filter_scheduler replacement_name: restrict_isolated_hosts_to_isolated_images - name: aggregate_image_properties_isolation_namespace replacement_group: filter_scheduler replacement_name: aggregate_image_properties_isolation_namespace - name: aggregate_image_properties_isolation_separator replacement_group: filter_scheduler replacement_name: aggregate_image_properties_isolation_separator - name: pci_alias replacement_group: pci replacement_name: alias - name: pci_passthrough_whitelist replacement_group: pci replacement_name: passthrough_whitelist - name: console_public_hostname replacement_group: xenserver replacement_name: console_public_hostname - name: console_token_ttl replacement_group: consoleauth replacement_name: token_ttl - name: rpc_zmq_bind_address replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_bind_address - name: rpc_zmq_matchmaker replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_matchmaker - name: rpc_zmq_contexts replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_contexts - name: rpc_zmq_topic_backlog replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_topic_backlog - name: rpc_zmq_ipc_dir replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_ipc_dir - name: rpc_zmq_host replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_host - name: rpc_cast_timeout replacement_group: oslo_messaging_zmq replacement_name: zmq_linger - name: rpc_poll_timeout replacement_group: oslo_messaging_zmq replacement_name: rpc_poll_timeout - name: zmq_target_expire replacement_group: oslo_messaging_zmq replacement_name: zmq_target_expire - name: zmq_target_update replacement_group: oslo_messaging_zmq replacement_name: zmq_target_update - name: use_pub_sub replacement_group: oslo_messaging_zmq replacement_name: use_pub_sub - name: use_router_proxy replacement_group: oslo_messaging_zmq replacement_name: use_router_proxy - name: rpc_zmq_min_port replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_min_port - name: rpc_zmq_max_port replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_max_port - name: rpc_zmq_bind_port_retries replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_bind_port_retries - name: rpc_zmq_serialization replacement_group: oslo_messaging_zmq replacement_name: rpc_zmq_serialization - name: osapi_max_request_body_size replacement_group: oslo_middleware replacement_name: max_request_body_size - name: max_request_body_size replacement_group: oslo_middleware replacement_name: max_request_body_size - name: vnc_enabled replacement_group: vnc replacement_name: enabled - name: vnc_keymap replacement_group: vnc replacement_name: keymap - name: vncserver_listen replacement_group: vnc replacement_name: vncserver_listen - name: vncserver_proxyclient_address replacement_group: vnc replacement_name: vncserver_proxyclient_address - name: novncproxy_base_url replacement_group: vnc replacement_name: novncproxy_base_url - name: xvpvncproxy_host replacement_group: vnc replacement_name: xvpvncproxy_host - name: xvpvncproxy_port replacement_group: vnc replacement_name: xvpvncproxy_port - name: xvpvncproxy_base_url replacement_group: vnc replacement_name: xvpvncproxy_base_url - name: novncproxy_host replacement_group: vnc replacement_name: novncproxy_host - name: novncproxy_port replacement_group: vnc replacement_name: novncproxy_port - name: auth_strategy replacement_group: api replacement_name: auth_strategy - name: use_forwarded_for replacement_group: api replacement_name: use_forwarded_for - name: config_drive_skip_versions replacement_group: api replacement_name: config_drive_skip_versions - name: vendordata_providers replacement_group: api replacement_name: vendordata_providers - name: vendordata_dynamic_targets replacement_group: api replacement_name: vendordata_dynamic_targets - name: vendordata_dynamic_ssl_certfile replacement_group: api replacement_name: vendordata_dynamic_ssl_certfile - name: vendordata_dynamic_connect_timeout replacement_group: api replacement_name: vendordata_dynamic_connect_timeout - name: vendordata_dynamic_read_timeout replacement_group: api replacement_name: vendordata_dynamic_read_timeout - name: metadata_cache_expiration replacement_group: api replacement_name: metadata_cache_expiration - name: vendordata_jsonfile_path replacement_group: api replacement_name: vendordata_jsonfile_path - name: osapi_max_limit replacement_group: api replacement_name: max_limit - name: osapi_compute_link_prefix replacement_group: api replacement_name: compute_link_prefix - name: osapi_glance_link_prefix replacement_group: api replacement_name: glance_link_prefix - name: allow_instance_snapshots replacement_group: api replacement_name: allow_instance_snapshots - name: osapi_hide_server_address_states replacement_group: api replacement_name: hide_server_address_states - name: fping_path replacement_group: api replacement_name: fping_path - name: use_neutron_default_nets replacement_group: api replacement_name: use_neutron_default_nets - name: neutron_default_tenant_id replacement_group: api replacement_name: neutron_default_tenant_id - name: enable_instance_password replacement_group: api replacement_name: enable_instance_password - name: api_paste_config replacement_group: wsgi replacement_name: api_paste_config - name: wsgi_log_format replacement_group: wsgi replacement_name: wsgi_log_format - name: secure_proxy_ssl_header replacement_group: wsgi replacement_name: secure_proxy_ssl_header - name: ssl_ca_file replacement_group: wsgi replacement_name: ssl_ca_file - name: ssl_cert_file replacement_group: wsgi replacement_name: ssl_cert_file - name: ssl_key_file replacement_group: wsgi replacement_name: ssl_key_file - name: tcp_keepidle replacement_group: wsgi replacement_name: tcp_keepidle - name: wsgi_default_pool_size replacement_group: wsgi replacement_name: default_pool_size - name: max_header_line replacement_group: wsgi replacement_name: max_header_line - name: wsgi_keep_alive replacement_group: wsgi replacement_name: keep_alive - name: client_socket_timeout replacement_group: wsgi replacement_name: client_socket_timeout - name: scheduler_host_manager replacement_group: scheduler replacement_name: host_manager - name: scheduler_driver replacement_group: scheduler replacement_name: driver - name: scheduler_driver_task_period replacement_group: scheduler replacement_name: periodic_task_interval - name: scheduler_max_attempts replacement_group: scheduler replacement_name: max_attempts - name: vpn_image_id replacement_group: cloudpipe replacement_name: vpn_image_id - name: vpn_flavor replacement_group: cloudpipe replacement_name: vpn_flavor - name: boot_script_template replacement_group: cloudpipe replacement_name: boot_script_template - name: dmz_net replacement_group: cloudpipe replacement_name: dmz_net - name: dmz_mask replacement_group: cloudpipe replacement_name: dmz_mask - name: vpn_key_suffix replacement_group: cloudpipe replacement_name: vpn_key_suffix - name: console_xvp_conf_template replacement_group: xvp replacement_name: console_xvp_conf_template - name: console_xvp_conf replacement_group: xvp replacement_name: console_xvp_conf - name: console_xvp_pid replacement_group: xvp replacement_name: console_xvp_pid - name: console_xvp_log replacement_group: xvp replacement_name: console_xvp_log - name: console_xvp_multiplex_port replacement_group: xvp replacement_name: console_xvp_multiplex_port amqp1: - name: container_name replacement_group: oslo_messaging_amqp replacement_name: container_name - name: idle_timeout replacement_group: oslo_messaging_amqp replacement_name: idle_timeout - name: trace replacement_group: oslo_messaging_amqp replacement_name: trace - name: ssl_ca_file replacement_group: oslo_messaging_amqp replacement_name: ssl_ca_file - name: ssl_cert_file replacement_group: oslo_messaging_amqp replacement_name: ssl_cert_file - name: ssl_key_file replacement_group: oslo_messaging_amqp replacement_name: ssl_key_file - name: ssl_key_password replacement_group: oslo_messaging_amqp replacement_name: ssl_key_password - name: allow_insecure_clients replacement_group: oslo_messaging_amqp replacement_name: allow_insecure_clients - name: sasl_mechanisms replacement_group: oslo_messaging_amqp replacement_name: sasl_mechanisms - name: sasl_config_dir replacement_group: oslo_messaging_amqp replacement_name: sasl_config_dir - name: sasl_config_name replacement_group: oslo_messaging_amqp replacement_name: sasl_config_name - name: username replacement_group: oslo_messaging_amqp replacement_name: username - name: password replacement_group: oslo_messaging_amqp replacement_name: password - name: server_request_prefix replacement_group: oslo_messaging_amqp replacement_name: server_request_prefix - name: broadcast_prefix replacement_group: oslo_messaging_amqp replacement_name: broadcast_prefix - name: group_request_prefix replacement_group: oslo_messaging_amqp replacement_name: group_request_prefix default: - name: console_allowed_origins replacement_group: console replacement_name: allowed_origins - name: notify_on_state_change replacement_group: notifications replacement_name: notify_on_state_change - name: notify_api_faults replacement_group: notifications replacement_name: notify_on_api_faults - name: default_notification_level replacement_group: notifications replacement_name: default_level - name: default_publisher_id replacement_group: notifications replacement_name: default_publisher_id - name: notification_format replacement_group: notifications replacement_name: notification_format ironic: - name: auth_plugin replacement_group: ironic replacement_name: auth_type - name: user_name replacement_group: ironic replacement_name: username keymgr: - name: fixed_key replacement_group: key_manager replacement_name: fixed_key keystone_authtoken: - name: memcache_servers replacement_group: keystone_authtoken replacement_name: memcached_servers - name: auth_plugin replacement_group: keystone_authtoken replacement_name: auth_type libvirt: - name: iscsi_use_multipath replacement_group: libvirt replacement_name: volume_use_multipath - name: iscsi_transport replacement_group: libvirt replacement_name: iscsi_iface neutron: - name: auth_plugin replacement_group: neutron replacement_name: auth_type - name: user_name replacement_group: neutron replacement_name: username oslo_messaging_rabbit: - name: kombu_ssl_version replacement_group: oslo_messaging_rabbit replacement_name: ssl_version - name: kombu_ssl_keyfile replacement_group: oslo_messaging_rabbit replacement_name: ssl_key_file - name: kombu_ssl_certfile replacement_group: oslo_messaging_rabbit replacement_name: ssl_cert_file - name: kombu_ssl_ca_certs replacement_group: oslo_messaging_rabbit replacement_name: ssl_ca_file - name: kombu_reconnect_timeout replacement_group: oslo_messaging_rabbit replacement_name: kombu_missing_consumer_retry_timeout placement: - name: auth_plugin replacement_group: placement replacement_name: auth_type - name: user_name replacement_group: placement replacement_name: username rpc_notifier2: - name: topics replacement_group: oslo_messaging_notifications replacement_name: topics service_user: - name: auth_plugin replacement_group: service_user replacement_name: auth_type - name: user_name replacement_group: service_user replacement_name: username sql: - name: connection replacement_group: database replacement_name: connection - name: idle_timeout replacement_group: database replacement_name: idle_timeout vendordata_dynamic_auth: - name: auth_plugin replacement_group: vendordata_dynamic_auth replacement_name: auth_type - name: user_name replacement_group: vendordata_dynamic_auth replacement_name: username generator_options: config_dir: [] config_file: - test.conf format_: yaml minimal: false namespace: - nova.conf - nova.api - nova.cells - oslo.log - oslo.messaging - oslo.policy - oslo.service.periodic_task - oslo.service.service - oslo.db - oslo.db.concurrency - oslo.middleware - oslo.concurrency - keystonemiddleware.auth_token output_file: etc/nova/nova.conf.sample.yaml summarize: false wrap_width: 80 options: DEFAULT: help: null opts: - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: run_external_periodic_tasks help: Some periodic tasks can be run in a separate process. Should we run them here? max: null metavar: null min: null mutable: false name: run_external_periodic_tasks namespace: oslo.service.periodic_task positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: backdoor_port help: Enable eventlet backdoor. Acceptable values are 0, , and :, where 0 results in listening on a random tcp port number; results in listening on the specified port number (and not enabling backdoor if that port is in use); and : results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. max: null metavar: null min: null mutable: false name: backdoor_port namespace: oslo.service.service positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: backdoor_socket help: Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with 'backdoor_port' in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. max: null metavar: null min: null mutable: false name: backdoor_socket namespace: oslo.service.service positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: log_options help: Enables or disables logging values of all registered options when starting a service (at DEBUG level). max: null metavar: null min: null mutable: false name: log_options namespace: oslo.service.service positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: graceful_shutdown_timeout help: Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. max: null metavar: null min: null mutable: false name: graceful_shutdown_timeout namespace: oslo.service.service positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_conn_pool_size deprecated_reason: null deprecated_since: null dest: rpc_conn_pool_size help: Size of RPC connection pool. max: null metavar: null min: null mutable: false name: rpc_conn_pool_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: conn_pool_min_size help: The pool size limit for connections expiration policy max: null metavar: null min: null mutable: false name: conn_pool_min_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1200 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: conn_pool_ttl help: The time-to-live in sec of idle connections in the pool max: null metavar: null min: null mutable: false name: conn_pool_ttl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: '*' deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_bind_address deprecated_reason: null deprecated_since: null dest: rpc_zmq_bind_address help: ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. max: null metavar: null min: null mutable: false name: rpc_zmq_bind_address namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: &id001 - redis - sentinel - dummy default: redis deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_matchmaker deprecated_reason: null deprecated_since: null dest: rpc_zmq_matchmaker help: MatchMaker driver. max: null metavar: null min: null mutable: false name: rpc_zmq_matchmaker namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_contexts deprecated_reason: null deprecated_since: null dest: rpc_zmq_contexts help: Number of ZeroMQ contexts, defaults to 1. max: null metavar: null min: null mutable: false name: rpc_zmq_contexts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_topic_backlog deprecated_reason: null deprecated_since: null dest: rpc_zmq_topic_backlog help: Maximum number of ingress messages to locally buffer per topic. Default is unlimited. max: null metavar: null min: null mutable: false name: rpc_zmq_topic_backlog namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: /var/run/openstack deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_ipc_dir deprecated_reason: null deprecated_since: null dest: rpc_zmq_ipc_dir help: Directory for holding IPC sockets. max: null metavar: null min: null mutable: false name: rpc_zmq_ipc_dir namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack.novalocal deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_host deprecated_reason: null deprecated_since: null dest: rpc_zmq_host help: Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. max: null metavar: null min: null mutable: false name: rpc_zmq_host namespace: oslo.messaging positional: false required: false sample_default: localhost secret: false short: null type: string value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_cast_timeout deprecated_reason: null deprecated_since: null dest: zmq_linger help: Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period. max: null metavar: null min: null mutable: false name: zmq_linger namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_poll_timeout deprecated_reason: null deprecated_since: null dest: rpc_poll_timeout help: The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. max: null metavar: null min: null mutable: false name: rpc_poll_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: zmq_target_expire deprecated_reason: null deprecated_since: null dest: zmq_target_expire help: Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). max: null metavar: null min: null mutable: false name: zmq_target_expire namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 180 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: zmq_target_update deprecated_reason: null deprecated_since: null dest: zmq_target_update help: Update period in seconds of a name service record about existing target. max: null metavar: null min: null mutable: false name: zmq_target_update namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_pub_sub deprecated_reason: null deprecated_since: null dest: use_pub_sub help: Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. max: null metavar: null min: null mutable: false name: use_pub_sub namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_router_proxy deprecated_reason: null deprecated_since: null dest: use_router_proxy help: Use ROUTER remote proxy. max: null metavar: null min: null mutable: false name: use_router_proxy namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_dynamic_connections help: This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise). max: null metavar: null min: null mutable: false name: use_dynamic_connections namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_failover_connections help: How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode. max: null metavar: null min: null mutable: false name: zmq_failover_connections namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 49153 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_min_port deprecated_reason: null deprecated_since: null dest: rpc_zmq_min_port help: Minimal port number for random ports range. max: 65535 metavar: null min: 0 mutable: false name: rpc_zmq_min_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 65536 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_max_port deprecated_reason: null deprecated_since: null dest: rpc_zmq_max_port help: Maximal port number for random ports range. max: 65536 metavar: null min: 1 mutable: false name: rpc_zmq_max_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_bind_port_retries deprecated_reason: null deprecated_since: null dest: rpc_zmq_bind_port_retries help: Number of retries to find free port number before fail with ZMQBindError. max: null metavar: null min: null mutable: false name: rpc_zmq_bind_port_retries namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: &id002 - json - msgpack default: json deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_serialization deprecated_reason: null deprecated_since: null dest: rpc_zmq_serialization help: Default serialization mechanism for serializing/deserializing outgoing/incoming messages max: null metavar: null min: null mutable: false name: rpc_zmq_serialization namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_immediate help: This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. max: null metavar: null min: null mutable: false name: zmq_immediate namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive help: Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_idle help: The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_idle namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_cnt help: The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_cnt namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_intvl help: The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_intvl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_thread_pool_size help: Maximum number of (green) threads to work concurrently. max: null metavar: null min: null mutable: false name: rpc_thread_pool_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_message_ttl help: Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server. max: null metavar: null min: null mutable: false name: rpc_message_ttl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_use_acks help: Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB. max: null metavar: null min: null mutable: false name: rpc_use_acks namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 15 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_ack_timeout_base help: Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier. max: null metavar: null min: null mutable: false name: rpc_ack_timeout_base namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_ack_timeout_multiplier help: Number to multiply base ack timeout by after each retry attempt. max: null metavar: null min: null mutable: false name: rpc_ack_timeout_multiplier namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_retry_attempts help: 'Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.' max: null metavar: null min: null mutable: false name: rpc_retry_attempts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: subscribe_on help: List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker. max: null metavar: null min: null mutable: false name: subscribe_on namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 64 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_thread_pool_size deprecated_reason: null deprecated_since: null dest: executor_thread_pool_size help: Size of executor thread pool. max: null metavar: null min: null mutable: false name: executor_thread_pool_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_response_timeout help: Seconds to wait for a response from a call. max: null metavar: null min: null mutable: false name: rpc_response_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: transport_url help: A URL representing the messaging driver to use and its full configuration. max: null metavar: null min: null mutable: false name: transport_url namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: rabbit deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rpc_backend help: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. max: null metavar: null min: null mutable: false name: rpc_backend namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: control_exchange help: The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. max: null metavar: null min: null mutable: false name: control_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: debug help: If set to true, the logging level will be set to DEBUG instead of the default INFO level. max: null metavar: null min: null mutable: true name: debug namespace: oslo.log positional: false required: false sample_default: null secret: false short: d type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: log_config deprecated_reason: null deprecated_since: null dest: log_config_append help: 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, logging_context_format_string). max: null metavar: PATH min: null mutable: true name: log-config-append namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%Y-%m-%d %H:%M:%S' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: log_date_format help: 'Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.' max: null metavar: DATE_FORMAT min: null mutable: false name: log-date-format namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: logfile deprecated_reason: null deprecated_since: null dest: log_file help: (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. max: null metavar: PATH min: null mutable: false name: log-file namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: logdir deprecated_reason: null deprecated_since: null dest: log_dir help: (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. max: null metavar: null min: null mutable: false name: log-dir namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: watch_log_file help: 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. max: null metavar: null min: null mutable: false name: watch-log-file namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_syslog help: 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. max: null metavar: null min: null mutable: false name: use-syslog namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: LOG_USER deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: syslog_log_facility help: Syslog facility to receive log lines. This option is ignored if log_config_append is set. max: null metavar: null min: null mutable: false name: syslog-log-facility namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_stderr help: Log output to standard error. This option is ignored if log_config_append is set. max: null metavar: null min: null mutable: false name: use_stderr namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: logging_context_format_string help: Format string to use for log messages with context. max: null metavar: null min: null mutable: false name: logging_context_format_string namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: logging_default_format_string help: Format string to use for log messages when context is undefined. max: null metavar: null min: null mutable: false name: logging_default_format_string namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(funcName)s %(pathname)s:%(lineno)d' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: logging_debug_format_suffix help: Additional data to append to log message when logging level for the message is DEBUG. max: null metavar: null min: null mutable: false name: logging_debug_format_suffix namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: logging_exception_prefix help: Prefix each line of exception output with this format. max: null metavar: null min: null mutable: false name: logging_exception_prefix namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: logging_user_identity_format help: Defines the format string for %(user_identity)s that is used in logging_context_format_string. max: null metavar: null min: null mutable: false name: logging_user_identity_format namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - amqp=WARN - amqplib=WARN - boto=WARN - qpid=WARN - sqlalchemy=WARN - suds=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 - dogpile.core.dogpile=INFO deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_log_levels help: List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. max: null metavar: null min: null mutable: false name: default_log_levels namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: publish_errors help: Enables or disables publication of error events. max: null metavar: null min: null mutable: false name: publish_errors namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '[instance: %(uuid)s] ' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_format help: The format for an instance that is passed with the log message. max: null metavar: null min: null mutable: false name: instance_format namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '[instance: %(uuid)s] ' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_uuid_format help: The format for an instance UUID that is passed with the log message. max: null metavar: null min: null mutable: false name: instance_uuid_format namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rate_limit_interval help: Interval, number of seconds, of log rate limiting. max: null metavar: null min: null mutable: false name: rate_limit_interval namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rate_limit_burst help: Maximum number of logged messages per rate_limit_interval. max: null metavar: null min: null mutable: false name: rate_limit_burst namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: CRITICAL deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rate_limit_except_level help: 'Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.' max: null metavar: null min: null mutable: false name: rate_limit_except_level namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: fatal_deprecations help: Enables or disables fatal status of deprecations. max: null metavar: null min: null mutable: false name: fatal_deprecations namespace: oslo.log positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: nova.api.metadata.vendordata_json.JsonFileVendorData deprecated_for_removal: true deprecated_opts: [] deprecated_reason: null deprecated_since: 13.0.0 dest: vendordata_driver help: ' When returning instance metadata, this is the class that is used for getting vendor metadata when that class isn''t specified in the individual request. The value should be the full dot-separated path to the class to use. Possible values: * Any valid dot-separated class path that can be imported. ' max: null metavar: null min: null mutable: false name: vendordata_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' CRUD operations on tenant networks are only available when using nova-network and nova-network is itself deprecated.' deprecated_since: 14.0.0 dest: enable_network_quota help: ' This option is used to enable or disable quota checking for tenant networks. Related options: * quota_networks ' max: null metavar: null min: null mutable: false name: enable_network_quota namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 3 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' CRUD operations on tenant networks are only available when using nova-network and nova-network is itself deprecated.' deprecated_since: 14.0.0 dest: quota_networks help: ' This option controls the number of private networks that can be created per project (or per tenant). Related options: * enable_network_quota ' max: null metavar: null min: 0 mutable: false name: quota_networks namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: internal deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: internal_service_availability_zone help: ' 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 ' max: null metavar: null min: null mutable: false name: internal_service_availability_zone namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_availability_zone help: ' 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 ' max: null metavar: null min: null mutable: false name: default_availability_zone namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 12 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password_length help: Length of generated instance admin passwords. max: null metavar: null min: 0 mutable: false name: password_length namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: month deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_usage_audit_period help: "\nTime period to generate instance usages for. It is possible to define\ \ optional\noffset to given period by appending @ character followed by a\ \ number defining\noffset.\n\nPossible values:\n\n* period, example: ``hour``,\ \ ``day``, ``month` or ``year``\n* period with offset, example: ``month@15``\ \ will result in monthly audits\n starting on 15th day of month.\n" max: null metavar: null min: null mutable: false name: instance_usage_audit_period namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_rootwrap_daemon help: ' Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes. ' max: null metavar: null min: null mutable: false name: use_rootwrap_daemon namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: /etc/nova/rootwrap.conf deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rootwrap_config help: ' 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. ' max: null metavar: null min: null mutable: false name: rootwrap_config namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tempdir help: Explicitly specify the temporary working directory. max: null metavar: null min: null mutable: false name: tempdir namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: monkey_patch help: "\nDetermine if monkey patching should be applied.\n\nRelated options:\n\ \n* ``monkey_patch_modules``: This must have values set for this option to\n\ \ have any effect\n" max: null metavar: null min: null mutable: false name: monkey_patch namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - nova.compute.api:nova.notifications.notify_decorator deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: monkey_patch_modules help: "\nList of modules/decorators to monkey patch.\n\nThis option allows you\ \ to patch a decorator for all functions in specified\nmodules.\n\nPossible\ \ values:\n\n* nova.compute.api:nova.notifications.notify_decorator\n* nova.api.ec2.cloud:nova.notifications.notify_decorator\n\ * [...]\n\nRelated options:\n\n* ``monkey_patch``: This must be set to ``True``\ \ for this option to\n have any effect\n" max: null metavar: null min: null mutable: false name: monkey_patch_modules namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: compute_driver help: ' Defines which driver to use for controlling virtualization. Possible values: * ``libvirt.LibvirtDriver`` * ``xenapi.XenAPIDriver`` * ``fake.FakeDriver`` * ``ironic.IronicDriver`` * ``vmwareapi.VMwareVCDriver`` * ``hyperv.HyperVDriver`` ' max: null metavar: null min: null mutable: false name: compute_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_resize_to_same_host help: ' Allow destination machine to match source for resize. Useful when testing in single-host environments. By default it is not allowed to resize to the same host. Setting this option to true will add the same host to the destination options. ' max: null metavar: null min: null mutable: false name: allow_resize_to_same_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_schedule_zone help: ' Availability zone to use when user doesn''t specify one. This option is used by the scheduler to determine which availability zone to place a new VM instance into if the user did not specify one at the time of VM boot request. Possible values: * Any string representing an availability zone name * Default value is None. ' max: null metavar: null min: null mutable: false name: default_schedule_zone namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - cache_in_nova - bittorrent deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: non_inheritable_image_properties help: "\nImage properties that should not be inherited from the instance\nwhen\ \ taking a snapshot.\n\nThis option gives an opportunity to select which image-properties\n\ should not be inherited by newly created snapshots.\n\nPossible values:\n\n\ * A list whose item is an image property. Usually only the image\n properties\ \ that are only needed by base images can be included\n here, since the snapshots\ \ that are created from the base images\n doesn't need them.\n* Default list:\ \ ['cache_in_nova', 'bittorrent']\n" max: null metavar: null min: null mutable: false name: non_inheritable_image_properties namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: nokernel deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' When an image is booted with the property ''kernel_id'' with the value ''nokernel'', Nova assumes the image doesn''t require an external kernel and ramdisk. This option allows user to change the API behaviour which should not be allowed and this value "nokernel" should be hard coded. ' deprecated_since: 15.0.0 dest: null_kernel help: ' This option is used to decide when an image should have no external ramdisk or kernel. By default this is set to ''nokernel'', so when an image is booted with the property ''kernel_id'' with the value ''nokernel'', Nova assumes the image doesn''t require an external kernel and ramdisk. ' max: null metavar: null min: null mutable: false name: null_kernel namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(name)s-%(count)d' deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' This config changes API behaviour. All changes in API behaviour should be discoverable. ' deprecated_since: 15.0.0 dest: multi_instance_display_name_template help: ' When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. Example display names when creating two VM''s: name-1, name-2. Possible values: * Valid keys for the template are: name, uuid, count. ' max: null metavar: null min: null mutable: false name: multi_instance_display_name_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_local_block_devices help: "\nMaximum number of devices that will result in a local image being\n\ created on the hypervisor node.\n\nA negative number means unlimited. Setting\ \ max_local_block_devices\nto 0 means that any request that attempts to create\ \ a local disk\nwill fail. This option is meant to limit the number of local\ \ discs\n(so root local disc that is the result of --image being used, and\n\ any other ephemeral and swap disks). 0 does not mean that images\nwill be\ \ automatically converted to volumes and boot instances from\nvolumes - it\ \ just means that all requests that attempt to create a\nlocal disk will fail.\n\ \nPossible values:\n\n* 0: Creating a local disk is not allowed.\n* Negative\ \ number: Allows unlimited number of local discs.\n* Positive number: Allows\ \ only these many number of local discs.\n (Default\ \ value is 3).\n" max: null metavar: null min: null mutable: false name: max_local_block_devices namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: compute_monitors help: "\nA list of monitors that can be used for getting compute metrics.\n\ You can use the alias/name from the setuptools entry points for\nnova.compute.monitors.*\ \ namespaces. If no namespace is supplied,\nthe \"cpu.\" namespace is assumed\ \ for backwards-compatibility.\n\nPossible values:\n\n* An empty list will\ \ disable the feature(Default).\n* An example value that would enable both\ \ the CPU and NUMA memory\n bandwidth monitors that used the virt driver\ \ variant:\n [\"cpu.virt_driver\", \"numa_mem_bw.virt_driver\"]\n" max: null metavar: null min: null mutable: false name: compute_monitors namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_ephemeral_format help: ' The default format an ephemeral_volume will be formatted with on creation. Possible values: * ``ext2`` * ``ext3`` * ``ext4`` * ``xfs`` * ``ntfs`` (only for Windows guests) ' max: null metavar: null min: null mutable: false name: default_ephemeral_format namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vif_plugging_is_fatal help: ' 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 ' max: null metavar: null min: null mutable: false name: vif_plugging_is_fatal namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vif_plugging_timeout help: "\nTimeout for Neutron VIF plugging event message arrival.\n\nNumber of\ \ seconds to wait for Neutron vif plugging events to\narrive before continuing\ \ or failing (see 'vif_plugging_is_fatal').\n\nRelated options:\n\n* vif_plugging_is_fatal\ \ - If ``vif_plugging_timeout`` is set to zero and\n ``vif_plugging_is_fatal``\ \ is False, events should not be expected to\n arrive at all.\n" max: null metavar: null min: 0 mutable: false name: vif_plugging_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: $pybasedir/nova/virt/interfaces.template deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: injected_network_template help: "Path to '/etc/network/interfaces' template.\n\nThe path to a template\ \ file for the '/etc/network/interfaces'-style file, which\nwill be populated\ \ by nova and subsequently used by cloudinit. This provides a\nmethod to configure\ \ network connectivity in environments without a DHCP server.\n\nThe template\ \ will be rendered using Jinja2 template engine, and receive a\ntop-level\ \ key called ``interfaces``. This key will contain a list of\ndictionaries,\ \ one for each interface.\n\nRefer to the cloudinit documentaion for more\ \ information:\n\n https://cloudinit.readthedocs.io/en/latest/topics/datasources.html\n\ \nPossible values:\n\n* A path to a Jinja2-formatted template for a Debian\ \ '/etc/network/interfaces'\n file. This applies even if using a non Debian-derived\ \ guest.\n\nRelated options:\n\n* ``flat_inject``: This must be set to ``True``\ \ to ensure nova embeds network\n configuration information in the metadata\ \ provided through the config drive.\n" max: null metavar: null min: null mutable: false name: injected_network_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - none - space default: none deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: preallocate_images help: ' The image preallocation mode to use. Image preallocation allows storage for instance images to be allocated up front when the instance is initially provisioned. This ensures immediate feedback is given if enough space isn''t available. In addition, it should significantly improve performance on writes to new blocks and may even improve I/O performance to prewritten blocks due to reduced fragmentation. Possible values: * "none" => no storage provisioning is done up front * "space" => storage is fully allocated at instance start ' max: null metavar: null min: null mutable: false name: preallocate_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_cow_images help: ' Enable use of copy-on-write (cow) images. QEMU/KVM allow the use of qcow2 as backing files. By disabling this, backing files will not be used. ' max: null metavar: null min: null mutable: false name: use_cow_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: force_raw_images help: ' Force conversion of backing images to raw format. Possible values: * True: Backing image files will be converted to raw image format * False: Backing image files will not be converted Related options: * ``compute_driver``: Only the libvirt driver uses this option. ' max: null metavar: null min: null mutable: false name: force_raw_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: virt_mkfs help: ' Name of the mkfs commands for ephemeral device. The format is = ' max: null metavar: null min: null mutable: false name: virt_mkfs namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: resize_fs_using_block_device help: ' Enable resizing of filesystems via a block device. If enabled, attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw). ' max: null metavar: null min: null mutable: false name: resize_fs_using_block_device namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout_nbd help: Amount of time, in seconds, to wait for NBD device start up. max: null metavar: null min: 0 mutable: false name: timeout_nbd namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: _base deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: image_cache_subdirectory_name help: ' Location of cached images. This is NOT the full path - just a folder name relative to ''$instances_path''. For per-compute-host cached images, set to ''_base_$my_ip'' ' max: null metavar: null min: null mutable: false name: image_cache_subdirectory_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: remove_unused_base_images help: Should unused base images be removed? max: null metavar: null min: null mutable: false name: remove_unused_base_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 86400 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: remove_unused_original_minimum_age_seconds help: ' Unused unresized base images younger than this will not be removed. ' max: null metavar: null min: null mutable: false name: remove_unused_original_minimum_age_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - null - ps2mouse - usbtablet default: usbtablet deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pointer_model help: "\nGeneric property to specify the pointer type.\n\nInput devices allow\ \ interaction with a graphical framebuffer. For\nexample to provide a graphic\ \ tablet for absolute cursor movement.\n\nIf set, the 'hw_pointer_model' image\ \ property takes precedence over\nthis configuration option.\n\nPossible values:\n\ \n* None: Uses default behavior provided by drivers (mouse on PS2 for\n \ \ libvirt x86)\n* ps2mouse: Uses relative movement. Mouse connected by\ \ PS2\n* usbtablet: Uses absolute movement. Tablet connect by USB\n\nRelated\ \ options:\n\n* usbtablet must be configured with VNC enabled or SPICE enabled\ \ and SPICE\n agent disabled. When used with libvirt the instance mode should\ \ be\n configured as HVM.\n " max: null metavar: null min: null mutable: false name: pointer_model namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vcpu_pin_set help: "\nDefines which physical CPUs (pCPUs) can be used by instance\nvirtual\ \ CPUs (vCPUs).\n\nPossible values:\n\n* A comma-separated list of physical\ \ CPU numbers that virtual CPUs can be\n allocated to by default. Each element\ \ should be either a single CPU number,\n a range of CPU numbers, or a caret\ \ followed by a CPU number to be\n excluded from a previous range. For example:\n\ \n vcpu_pin_set = \"4-12,^8,15\"\n" max: null metavar: null min: null mutable: false name: vcpu_pin_set namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reserved_huge_pages help: "\nNumber of huge/large memory pages to reserved per NUMA host cell.\n\ \nPossible values:\n\n* A list of valid key=value which reflect NUMA node\ \ ID, page size\n (Default unit is KiB) and number of pages to be reserved.\n\ \n reserved_huge_pages = node:0,size:2048,count:64\n reserved_huge_pages\ \ = node:1,size:1GB,count:1\n\n In this example we are reserving on NUMA\ \ node 0 64 pages of 2MiB\n and on NUMA node 1 1 page of 1GiB.\n" max: null metavar: null min: null mutable: false name: reserved_huge_pages namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: dict value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reserved_host_disk_mb help: "\nAmount of disk resources in MB to make them always available to host.\ \ The\ndisk usage gets reported back to the scheduler from nova-compute running\n\ on the compute nodes. To prevent the disk resources from being considered\n\ as available, this option can be used to reserve disk space for that host.\n\ \nPossible values:\n\n* Any positive integer representing amount of disk in\ \ MB to reserve\n for the host.\n" max: null metavar: null min: 0 mutable: false name: reserved_host_disk_mb namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 512 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reserved_host_memory_mb help: "\nAmount of memory in MB to reserve for the host so that it is always\ \ available\nto host processes. The host resources usage is reported back\ \ to the scheduler\ncontinuously from nova-compute running on the compute\ \ node. To prevent the host\nmemory from being considered as available, this\ \ option is used to reserve\nmemory for the host.\n\nPossible values:\n\n\ * Any positive integer representing amount of memory in MB to reserve\n for\ \ the host.\n" max: null metavar: null min: 0 mutable: false name: reserved_host_memory_mb namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cpu_allocation_ratio help: ' This option helps you specify virtual CPU to physical CPU allocation ratio. From Ocata (15.0.0) this is used to influence the hosts selected by the Placement API. Note that when Placement is used, the CoreFilter is redundant, because the Placement API will have already filtered out hosts that would have failed the CoreFilter. This configuration specifies ratio for CoreFilter which can be set per compute node. For AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting is found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) or compute node(s) will be used and defaulted to 16.0''. Possible values: * Any valid positive integer or float value ' max: null metavar: null min: 0.0 mutable: false name: cpu_allocation_ratio namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ram_allocation_ratio help: ' This option helps you specify virtual RAM to physical RAM allocation ratio. From Ocata (15.0.0) this is used to influence the hosts selected by the Placement API. Note that when Placement is used, the RamFilter is redundant, because the Placement API will have already filtered out hosts that would have failed the RamFilter. This configuration specifies ratio for RamFilter which can be set per compute node. For AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) or compute node(s) will be used and defaulted to 1.5. Possible values: * Any valid positive integer or float value ' max: null metavar: null min: 0.0 mutable: false name: ram_allocation_ratio namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disk_allocation_ratio help: ' This option helps you specify virtual disk to physical disk allocation ratio. From Ocata (15.0.0) this is used to influence the hosts selected by the Placement API. Note that when Placement is used, the DiskFilter is redundant, because the Placement API will have already filtered out hosts that would have failed the DiskFilter. A ratio greater than 1.0 will result in over-subscription of the available physical disk, which can be useful for more efficiently packing instances created with images that do not use the entire virtual disk, such as sparse or compressed images. It can be set to a value between 0.0 and 1.0 in order to preserve a percentage of the disk for uses other than instances. NOTE: This can be set per-compute, or if set to 0.0, the value set on the scheduler node(s) or compute node(s) will be used and defaulted to 1.0''. Possible values: * Any valid positive integer or float value ' max: null metavar: null min: 0.0 mutable: false name: disk_allocation_ratio namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: openstack.novalocal deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: console_host help: ' Console proxy host to be used to connect to instances on this host. It is the publicly visible name for the console host. Possible values: * Current hostname (default) or any string representing hostname. ' max: null metavar: null min: null mutable: false name: console_host namespace: nova.conf positional: false required: false sample_default: socket.gethostname() secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_access_ip_network_name help: ' 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. ' max: null metavar: null min: null mutable: false name: default_access_ip_network_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: defer_iptables_apply help: ' Whether to batch up the application of IPTables rules during a host restart and apply all at the end of the init phase. ' max: null metavar: null min: null mutable: false name: defer_iptables_apply namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: $state_path/instances deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instances_path help: "\nSpecifies where instances are stored on the hypervisor's disk.\nIt\ \ can point to locally attached storage or a directory on NFS.\n\nPossible\ \ values:\n\n* $state_path/instances where state_path is a config option that\ \ specifies\n the top-level directory for maintaining nova's state. (default)\ \ or\n Any string representing directory path.\n" max: null metavar: null min: null mutable: false name: instances_path namespace: nova.conf positional: false required: false sample_default: $state_path/instances secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_usage_audit help: ' This option enables periodic compute.instance.exists notifications. Each compute node must be configured to generate system usage data. These notifications are consumed by OpenStack Telemetry service. ' max: null metavar: null min: null mutable: false name: instance_usage_audit namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_retry_count help: ' Maximum number of 1 second retries in live_migration. It specifies number of retries to iptables when it complains. It happens when an user continuously sends live-migration request to same host leading to concurrent request to iptables. Possible values: * Any positive integer representing retry count. ' max: null metavar: null min: 0 mutable: false name: live_migration_retry_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: resume_guests_state_on_host_boot help: ' This option specifies whether to start guests that were running before the host rebooted. It ensures that all of the instances on a Nova compute node resume their state each time the compute node boots or restarts. ' max: null metavar: null min: null mutable: false name: resume_guests_state_on_host_boot namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: network_allocate_retries help: ' Number of times to retry network allocation. It is required to attempt network allocation retries if the virtual interface plug fails. Possible values: * Any positive integer representing retry count. ' max: null metavar: null min: 0 mutable: false name: network_allocate_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_concurrent_builds help: ' 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. ' max: null metavar: null min: 0 mutable: false name: max_concurrent_builds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_concurrent_live_migrations help: "\nMaximum number of live migrations to run concurrently. This limit is\ \ enforced\nto avoid outbound live migrations overwhelming the host/network\ \ and causing\nfailures. It is not recommended that you change this unless\ \ you are very sure\nthat doing so is safe and stable in your environment.\n\ \nPossible values:\n\n* 0 : treated as unlimited.\n* Negative value defaults\ \ to 0.\n* Any positive integer representing maximum number of live migrations\n\ \ to run concurrently.\n" max: null metavar: null min: null mutable: false name: max_concurrent_live_migrations namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: block_device_allocate_retries help: ' 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) ' max: null metavar: null min: null mutable: false name: block_device_allocate_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sync_power_state_pool_size help: ' 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. ' max: null metavar: null min: null mutable: false name: sync_power_state_pool_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2400 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: image_cache_manager_interval help: ' Number of seconds to wait between runs of the image cache manager. Possible values: * 0: run at the default rate. * -1: disable * Any other value ' max: null metavar: null min: -1 mutable: false name: image_cache_manager_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: bandwidth_poll_interval help: ' Interval to pull network bandwidth usage info. Not supported on all hypervisors. If a hypervisor doesn''t support bandwidth usage, it will not get the info in the usage events. Possible values: * 0: Will run at the default periodic interval. * Any value < 0: Disables the option. * Any positive integer in seconds. ' max: null metavar: null min: null mutable: false name: bandwidth_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sync_power_state_interval help: "\nInterval to sync power states between the database and the hypervisor.\n\ \nThe interval that Nova checks the actual virtual machine power state\nand\ \ the power state that Nova has in its database. If a user powers\ndown their\ \ VM, Nova updates the API to report the VM has been\npowered down. Should\ \ something turn on the VM unexpectedly,\nNova will turn the VM back off to\ \ keep the system in the expected\nstate.\n\nPossible values:\n\n* 0: Will\ \ run at the default periodic interval.\n* Any value < 0: Disables the option.\n\ * Any positive integer in seconds.\n\nRelated options:\n\n* If ``handle_virt_lifecycle_events``\ \ in workarounds_group is\n false and this option is negative, then instances\ \ that get out\n of sync between the hypervisor and the Nova database will\ \ have\n to be synchronized manually.\n" max: null metavar: null min: null mutable: false name: sync_power_state_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: heal_instance_info_cache_interval help: ' Interval between instance network information cache updates. Number of seconds after which each compute node runs the task of querying Neutron for all of its instances networking information, then updates the Nova db with that information. Nova will never update it''s cache if this option is set to 0. If we don''t update the cache, the metadata service and nova-api endpoints will be proxying incorrect network data about the instance. So, it is not recommended to set this option to 0. Possible values: * Any positive integer in seconds. * Any value <=0 will disable the sync. This is not recommended. ' max: null metavar: null min: null mutable: false name: heal_instance_info_cache_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reclaim_instance_interval help: "\nInterval for reclaiming deleted instances.\n\nA value greater than\ \ 0 will enable SOFT_DELETE of instances.\nThis option decides whether the\ \ server to be deleted will be put into\nthe SOFT_DELETED state. If this value\ \ is greater than 0, the deleted\nserver will not be deleted immediately,\ \ instead it will be put into\na queue until it's too old (deleted time greater\ \ than the value of\nreclaim_instance_interval). The server can be recovered\ \ from the\ndelete queue by using the restore action. If the deleted server\ \ remains\nlonger than the value of reclaim_instance_interval, it will be\n\ deleted by a periodic task in the compute service automatically.\n\nNote that\ \ this option is read from both the API and compute nodes, and\nmust be set\ \ globally otherwise servers could be put into a soft deleted\nstate in the\ \ API and never actually reclaimed (deleted) on the compute\nnode.\n\nPossible\ \ values:\n\n* Any positive integer(in seconds) greater than 0 will enable\n\ \ this option.\n* Any value <=0 will disable the option.\n" max: null metavar: null min: null mutable: false name: reclaim_instance_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: volume_usage_poll_interval help: "\nInterval for gathering volume usages.\n\nThis option updates the volume\ \ usage cache for every\nvolume_usage_poll_interval number of seconds.\n\n\ Possible values:\n\n* Any positive integer(in seconds) greater than 0 will\ \ enable\n this option.\n* Any value <=0 will disable the option.\n" max: null metavar: null min: null mutable: false name: volume_usage_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: shelved_poll_interval help: ' Interval for polling shelved instances to offload. The periodic task runs for every shelved_poll_interval number of seconds and checks if there are any shelved instances. If it finds a shelved instance, based on the ''shelved_offload_time'' config value it offloads the shelved instances. Check ''shelved_offload_time'' config option description for details. Possible values: * Any value <= 0: Disables the option. * Any positive integer in seconds. Related options: * ``shelved_offload_time`` ' max: null metavar: null min: null mutable: false name: shelved_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: shelved_offload_time help: "\nTime before a shelved instance is eligible for removal from a host.\n\ \nBy default this option is set to 0 and the shelved instance will be\nremoved\ \ from the hypervisor immediately after shelve operation.\nOtherwise, the\ \ instance will be kept for the value of\nshelved_offload_time(in seconds)\ \ so that during the time period the\nunshelve action will be faster, then\ \ the periodic task will remove\nthe instance from hypervisor after shelved_offload_time\ \ passes.\n\nPossible values:\n\n* 0: Instance will be immediately offloaded\ \ after being\n shelved.\n* Any value < 0: An instance will never offload.\n\ * Any positive integer in seconds: The instance will exist for\n the specified\ \ number of seconds before being offloaded.\n" max: null metavar: null min: null mutable: false name: shelved_offload_time namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_delete_interval help: "\nInterval for retrying failed instance file deletes.\n\nThis option\ \ depends on 'maximum_instance_delete_attempts'.\nThis option specifies how\ \ often to retry deletes whereas\n'maximum_instance_delete_attempts' specifies\ \ the maximum number\nof retry attempts that can be made.\n\nPossible values:\n\ \n* 0: Will run at the default periodic interval.\n* Any value < 0: Disables\ \ the option.\n* Any positive integer in seconds.\n\nRelated options:\n\n\ * ``maximum_instance_delete_attempts`` from instance_cleaning_opts\n group.\n" max: null metavar: null min: null mutable: false name: instance_delete_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: block_device_allocate_retries_interval help: "\nInterval (in seconds) between block device allocation retries on failures.\n\ \nThis option allows the user to specify the time interval between\nconsecutive\ \ retries. 'block_device_allocate_retries' option specifies\nthe maximum number\ \ of retries.\n\nPossible values:\n\n* 0: Disables the option.\n* Any positive\ \ integer in seconds enables the option.\n\nRelated options:\n\n* ``block_device_allocate_retries''\ \ in compute_manager_opts\n group.\n" max: null metavar: null min: 0 mutable: false name: block_device_allocate_retries_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 120 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler_instance_sync_interval help: "\nInterval between sending the scheduler a list of current instance UUIDs\ \ to\nverify that its view of instances is in sync with nova.\n\nIf the CONF\ \ option 'scheduler_tracks_instance_changes' is\nFalse, the sync calls will\ \ not be made. So, changing this option will\nhave no effect.\n\nIf the out\ \ of sync situations are not very common, this interval\ncan be increased\ \ to lower the number of RPC messages being sent.\nLikewise, if sync issues\ \ turn out to be a problem, the interval\ncan be lowered to check more frequently.\n\ \nPossible values:\n\n* 0: Will run at the default periodic interval.\n* Any\ \ value < 0: Disables the option.\n* Any positive integer in seconds.\n\n\ Related options:\n\n* This option has no impact if ``scheduler_tracks_instance_changes``\n\ \ is set to False.\n" max: null metavar: null min: null mutable: false name: scheduler_instance_sync_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: update_resources_interval help: ' Interval for updating compute resources. This option specifies how often the update_available_resources periodic task should run. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. Possible values: * 0: Will run at the default periodic interval. * Any value < 0: Disables the option. * Any positive integer in seconds. ' max: null metavar: null min: null mutable: false name: update_resources_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reboot_timeout help: ' 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. ' max: null metavar: null min: 0 mutable: false name: reboot_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_build_timeout help: ' Maximum time in seconds that an instance can take to build. If this timer expires, instance status will be changed to ERROR. Enabling this option will make sure an instance will not be stuck in BUILD state for a longer period. Possible values: * 0: Disables the option (default) * Any positive integer in seconds: Enables the option. ' max: null metavar: null min: 0 mutable: false name: instance_build_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rescue_timeout help: ' 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. ' max: null metavar: null min: 0 mutable: false name: rescue_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: resize_confirm_window help: ' Automatically confirm resizes after N seconds. Resize functionality will save the existing server before resizing. After the resize completes, user is requested to confirm the resize. The user has the opportunity to either confirm or revert all changes. Confirm resize removes the original server and changes server status from resized to active. Setting this option to a time period (in seconds) will automatically confirm the resize if the server is in resized state longer than that time. Possible values: * 0: Disables the option (default) * Any positive integer in seconds: Enables the option. ' max: null metavar: null min: 0 mutable: false name: resize_confirm_window namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: shutdown_timeout help: ' 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). ' max: null metavar: null min: 1 mutable: false name: shutdown_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - noop - log - shutdown - reap default: reap deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: running_deleted_instance_action help: "\nThe compute service periodically checks for instances that have been\n\ deleted in the database but remain running on the compute node. The\nabove\ \ option enables action to be taken when such instances are\nidentified.\n\ \nPossible values:\n\n* reap: Powers down the instances and deletes them(default)\n\ * log: Logs warning message about deletion of the resource\n* shutdown: Powers\ \ down instances and marks them as non-\n bootable which can be later used\ \ for debugging/analysis\n* noop: Takes no action\n\nRelated options:\n\n\ * running_deleted_instance_poll\n* running_deleted_instance_timeout\n" max: null metavar: null min: null mutable: false name: running_deleted_instance_action namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1800 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: running_deleted_instance_poll_interval help: ' 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 ' max: null metavar: null min: null mutable: false name: running_deleted_instance_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: running_deleted_instance_timeout help: ' Time interval in seconds to wait for the instances that have been marked as deleted in database to be eligible for cleanup. Possible values: * Any positive integer in seconds(default is 0). Related options: * "running_deleted_instance_action" ' max: null metavar: null min: null mutable: false name: running_deleted_instance_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: maximum_instance_delete_attempts help: "\nThe number of times to attempt to reap an instance's files.\n\nThis\ \ option specifies the maximum number of retry attempts\nthat can be made.\n\ \nPossible values:\n\n* Any positive integer defines how many attempts are\ \ made.\n* Any value <=0 means no delete attempts occur, but you should use\n\ \ ``instance_delete_interval`` to disable the delete attempts.\n\nRelated\ \ options:\n* ``instance_delete_interval`` in interval_opts group can be used\ \ to disable\n this option.\n" max: null metavar: null min: null mutable: false name: maximum_instance_delete_attempts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: compute deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There is no need to let users choose the RPC topic for all services - there is little gain from this. Furthermore, it makes it really easy to break Nova by using this option. ' deprecated_since: 15.0.0 dest: compute_topic help: "\nThis is the message queue topic that the compute service 'listens'\ \ on. It is\nused when the compute service is started up to configure the\ \ queue, and\nwhenever an RPC call to the compute service is made.\n\nPossible\ \ values:\n\n* Any string, but there is almost never any reason to ever change\ \ this value\n from its default of 'compute'.\n" max: null metavar: null min: null mutable: false name: compute_topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - '' - project - global default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: osapi_compute_unique_server_name_scope help: "\nSets the scope of the check for unique instance names.\n\nThe default\ \ doesn't check for unique names. If a scope for the name check is\nset, a\ \ launch of a new instance or an update of an existing instance with a\nduplicate\ \ name will result in an ''InstanceExists'' error. The uniqueness is\ncase-insensitive.\ \ Setting this option can increase the usability for end\nusers as they don't\ \ have to distinguish among instances with the same name\nby their IDs.\n\n\ Possible values:\n\n* '': An empty value means that no uniqueness check is\ \ done and duplicate\n names are possible.\n* \"project\": The instance name\ \ check is done only for instances within the\n same project.\n* \"global\"\ : The instance name check is done for all instances regardless of\n the project.\n" max: null metavar: null min: null mutable: false name: osapi_compute_unique_server_name_scope namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enable_new_services help: "\nEnable new services on this host automatically.\n\nWhen a new service\ \ (for example \"nova-compute\") starts up, it gets\nregistered in the database\ \ as an enabled service. Sometimes it can be useful\nto register new services\ \ in disabled state and then enabled them at a later\npoint in time. This\ \ option can set this behavior for all services per host.\n\nPossible values:\n\ \n* ``True``: Each new service is enabled as soon as it registers itself.\n\ * ``False``: Services must be enabled via a REST API call or with the CLI\n\ \ with ``nova service-enable ``, otherwise they are not\n\ \ ready to use.\n" max: null metavar: null min: null mutable: false name: enable_new_services namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: instance-%08x deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_name_template help: "\nTemplate string to be used to generate instance names.\n\nThis template\ \ controls the creation of the database name of an instance. This\nis *not*\ \ the display name you enter when creating an instance (via Horizon\nor CLI).\ \ For a new deployment it is advisable to change the default value\n(which\ \ uses the database autoincrement) to another value which makes use\nof the\ \ attributes of an instance, like ``instance-%(uuid)s``. If you\nalready have\ \ instances in your deployment when you change this, your\ndeployment will\ \ break.\n\nPossible values:\n\n* A string which either uses the instance\ \ database ID (like the\n default)\n* A string with a list of named database\ \ columns, for example ``%(id)d``\n or ``%(uuid)s`` or ``%(hostname)s``.\n\ \nRelated options:\n\n* not to be confused with: ``multi_instance_display_name_template``\n" max: null metavar: null min: null mutable: false name: instance_name_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: migrate_max_retries help: ' 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 ' max: null metavar: null min: -1 mutable: false name: migrate_max_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - iso9660 - vfat default: iso9660 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: config_drive_format help: "\nConfiguration drive format\n\nConfiguration drive format that will\ \ contain metadata attached to the\ninstance when it boots.\n\nPossible values:\n\ \n* iso9660: A file system image standard that is widely supported across\n\ \ operating systems. NOTE: Mind the libvirt bug\n (https://bugs.launchpad.net/nova/+bug/1246201)\ \ - If your hypervisor\n driver is libvirt, and you want live migrate to\ \ work without shared storage,\n then use VFAT.\n* vfat: For legacy reasons,\ \ you can configure the configuration drive to\n use VFAT format instead\ \ of ISO 9660.\n\nRelated options:\n\n* This option is meaningful when one\ \ of the following alternatives occur:\n 1. force_config_drive option set\ \ to 'true'\n 2. the REST API call to create the instance contains an enable\ \ flag for\n config drive option\n 3. the image used to create the instance\ \ requires a config drive,\n this is defined by img_config_drive property\ \ for that image.\n* A compute node running Hyper-V hypervisor can be configured\ \ to attach\n configuration drive as a CD drive. To attach the configuration\ \ drive as a CD\n drive, set config_drive_cdrom option at hyperv section,\ \ to true.\n" max: null metavar: null min: null mutable: false name: config_drive_format namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: force_config_drive help: "\nForce injection to take place on a config drive\n\nWhen this option\ \ is set to true configuration drive functionality will be\nforced enabled\ \ by default, otherwise user can still enable configuration\ndrives via the\ \ REST API or image metadata properties.\n\nPossible values:\n\n* True: Force\ \ to use of configuration drive regardless the user's input in the\n \ \ REST API call.\n* False: Do not force use of configuration drive. Config\ \ drives can still be\n enabled via the REST API or image metadata\ \ properties.\n\nRelated options:\n\n* Use the 'mkisofs_cmd' flag to set the\ \ path where you install the\n genisoimage program. If genisoimage is in\ \ same path as the\n nova-compute service, you do not need to set this flag.\n\ * To use configuration drive with Hyper-V, you must set the\n 'mkisofs_cmd'\ \ value to the full path to an mkisofs.exe installation.\n Additionally,\ \ you must set the qemu_img_cmd value in the hyperv\n configuration section\ \ to the full path to an qemu-img command\n installation.\n" max: null metavar: null min: null mutable: false name: force_config_drive namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: genisoimage deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mkisofs_cmd help: "\nName or path of the tool used for ISO image creation\n\nUse the mkisofs_cmd\ \ flag to set the path where you install the genisoimage\nprogram. If genisoimage\ \ is on the system path, you do not need to change\nthe default value.\n\n\ To use configuration drive with Hyper-V, you must set the mkisofs_cmd value\n\ to the full path to an mkisofs.exe installation. Additionally, you must set\n\ the qemu_img_cmd value in the hyperv configuration section to the full path\n\ to an qemu-img command installation.\n\nPossible values:\n\n* Name of the\ \ ISO image creator program, in case it is in the same directory\n as the\ \ nova-compute service\n* Path to ISO image creator program\n\nRelated options:\n\ \n* This option is meaningful when config drives are enabled.\n* To use configuration\ \ drive with Hyper-V, you must set the qemu_img_cmd\n value in the hyperv\ \ configuration section to the full path to an qemu-img\n command installation.\n" max: null metavar: null min: null mutable: false name: mkisofs_cmd namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.console.xvp.XVPConsoleProxy deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' This option no longer does anything. Previously this option had only two valid, in-tree values: nova.console.xvp.XVPConsoleProxy and nova.console.fake.FakeConsoleProxy. The latter of these was only used in tests and has since been replaced. ' deprecated_since: 15.0.0 dest: console_driver help: ' 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: * A string representing fully classified class name of console driver. ' max: null metavar: null min: null mutable: false name: console_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: console deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There is no need to let users choose the RPC topic for all services - there is little gain from this. Furthermore, it makes it really easy to break Nova by using this option. ' deprecated_since: 15.0.0 dest: console_topic help: ' 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: * A string representing topic exchange name ' max: null metavar: null min: null mutable: false name: console_topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: consoleauth deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There is no need to let users choose the RPC topic for all services - there is little gain from this. Furthermore, it makes it really easy to break Nova by using this option. ' deprecated_since: 15.0.0 dest: consoleauth_topic help: ' This option allows you to change the message topic used by nova-consoleauth service when communicating via the AMQP server. Nova Console Authentication server authenticates nova consoles. Users can then access their instances through VNC clients. The Nova API service uses a message queue to communicate with nova-consoleauth to get a VNC console. Possible Values: * ''consoleauth'' (default) or Any string representing topic exchange name. ' max: null metavar: null min: null mutable: false name: consoleauth_topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.db deprecated_for_removal: true deprecated_opts: [] deprecated_reason: null deprecated_since: 13.0.0 dest: db_driver help: The driver to use for database access max: null metavar: null min: null mutable: false name: db_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: m1.small deprecated_for_removal: true deprecated_opts: [] deprecated_reason: The EC2 API is deprecated. deprecated_since: 14.0.0 dest: default_flavor help: ' Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. ' max: null metavar: null min: null mutable: false name: default_flavor namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_floating_pool help: ' Default pool for floating IPs. This option specifies the default floating IP pool for allocating floating IPs. While allocating a floating ip, users can optionally pass in the name of the pool they want to allocate from, otherwise it will be pulled from the default pool. If this option is not set, then ''nova'' is used as default floating pool. Possible values: * Any string representing a floating IP pool name ' max: null metavar: null min: null mutable: false name: default_floating_pool namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: auto_assign_floating_ip help: ' Autoassigning floating IP to VM When set to True, floating IP is auto allocated and associated to the VM upon creation. Related options: * use_neutron: this options only works with nova-network. ' max: null metavar: null min: null mutable: false name: auto_assign_floating_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: nova.network.noop_dns_driver.NoopDNSDriver deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: floating_ip_dns_manager help: ' 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 Related options: * use_neutron: this options only works with nova-network. ' max: null metavar: null min: null mutable: false name: floating_ip_dns_manager namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.network.noop_dns_driver.NoopDNSDriver deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: instance_dns_manager help: ' Full class name for the DNS Manager for instance IPs. This option specifies the class of the driver that provides functionality to manage DNS entries for instances. On instance creation, nova will add DNS entries for the instance name and id, using the specified instance DNS driver and domain. On instance deletion, nova will remove the DNS entries. Possible values: * Full Python path to the class to be used Related options: * use_neutron: this options only works with nova-network. ' max: null metavar: null min: null mutable: false name: instance_dns_manager namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: instance_dns_domain help: ' If specified, Nova checks if the availability_zone of every instance matches what the database says the availability_zone should be for the specified dns_domain. Related options: * use_neutron: this options only works with nova-network. ' max: null metavar: null min: null mutable: false name: instance_dns_domain namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - rfc2462 - account_identifier default: rfc2462 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ipv6_backend help: ' 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. ' max: null metavar: null min: null mutable: false name: ipv6_backend namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 12.1.1.105 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: my_ip help: ' The IP address which the host is using to connect to the management network. Possible values: * String with valid IP address. Default is IPv4 address of this host. Related options: * metadata_host * my_block_storage_ip * routing_source_ip * vpn_ip ' max: null metavar: null min: null mutable: false name: my_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $my_ip deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: my_block_storage_ip help: ' 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. ' max: null metavar: null min: null mutable: false name: my_block_storage_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack.novalocal deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host help: ' 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. ' max: null metavar: null min: null mutable: false name: host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_ipv6 help: ' Assign IPv6 and IPv4 addresses when creating instances. Related options: * use_neutron: this only works with nova-network. ' max: null metavar: null min: null mutable: false name: use_ipv6 namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - /etc/nova/nova-dhcpbridge.conf deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dhcpbridge_flagfile help: "\nThis option is a list of full paths to one or more configuration files\ \ for\ndhcpbridge. In most cases the default path of '/etc/nova/nova-dhcpbridge.conf'\n\ should be sufficient, but if you have special needs for configuring dhcpbridge,\n\ you can change or add to this list.\n\nPossible values\n\n A list of strings,\ \ where each string is the full path to a dhcpbridge\n configuration file.\n" max: null metavar: null min: null mutable: false name: dhcpbridge_flagfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: $state_path/networks deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: networks_path help: "\nThe location where the network configuration files will be kept. The\ \ default is\nthe 'networks' directory off of the location where nova's Python\ \ module is\ninstalled.\n\nPossible values\n\n A string containing the\ \ full path to the desired configuration directory\n" max: null metavar: null min: null mutable: false name: networks_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: eth0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: public_interface help: "\nThis is the name of the network interface for public IP addresses.\ \ The default\nis 'eth0'.\n\nPossible values:\n\n Any string representing\ \ a network interface name\n" max: null metavar: null min: null mutable: false name: public_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $bindir/nova-dhcpbridge deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dhcpbridge help: "\nThe location of the binary nova-dhcpbridge. By default it is the binary\ \ named\n'nova-dhcpbridge' that is installed with all the other nova binaries.\n\ \nPossible values:\n\n Any string representing the full path to the binary\ \ for dhcpbridge\n" max: null metavar: null min: null mutable: false name: dhcpbridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $my_ip deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: routing_source_ip help: "\nThis is the public IP address of the network host. It is used when\ \ creating a\nSNAT rule.\n\nPossible values:\n\n Any valid IP address\n\ \nRelated options:\n\n force_snat_range\n" max: null metavar: null min: null mutable: false name: routing_source_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 86400 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dhcp_lease_time help: "\nThe lifetime of a DHCP lease, in seconds. The default is 86400 (one\ \ day).\n\nPossible values:\n\n Any positive integer value.\n" max: null metavar: null min: 1 mutable: false name: dhcp_lease_time namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dns_server help: "\nDespite the singular form of the name of this option, it is actually\ \ a list of\nzero or more server addresses that dnsmasq will use for DNS nameservers.\ \ If\nthis is not empty, dnsmasq will not read /etc/resolv.conf, but will\ \ only use\nthe servers specified in this option. If the option use_network_dns_servers\ \ is\nTrue, the dns1 and dns2 servers from the network will be appended to\ \ this list,\nand will be used as DNS servers, too.\n\nPossible values:\n\n\ \ A list of strings, where each string is either an IP address or a FQDN.\n\ \nRelated options:\n\n use_network_dns_servers\n" max: null metavar: null min: null mutable: false name: dns_server namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_network_dns_servers help: "\nWhen this option is set to True, the dns1 and dns2 servers for the\ \ network\nspecified by the user on boot will be used for DNS, as well as\ \ any specified in\nthe `dns_server` option.\n\nRelated options:\n\n dns_server\n" max: null metavar: null min: null mutable: false name: use_network_dns_servers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dmz_cidr help: "\nThis option is a list of zero or more IP address ranges in your network's\ \ DMZ\nthat should be accepted.\n\nPossible values:\n\n A list of strings,\ \ each of which should be a valid CIDR.\n" max: null metavar: null min: null mutable: false name: dmz_cidr namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: force_snat_range help: "\nThis is a list of zero or more IP ranges that traffic from the\n`routing_source_ip`\ \ will be SNATted to. If the list is empty, then no SNAT\nrules are created.\n\ \nPossible values:\n\n A list of strings, each of which should be a valid\ \ CIDR.\n\nRelated options:\n\n routing_source_ip\n" max: null metavar: null min: null mutable: false name: force_snat_range namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dnsmasq_config_file help: "\nThe path to the custom dnsmasq configuration file, if any.\n\nPossible\ \ values:\n\n The full path to the configuration file, or an empty string\ \ if there is no\n custom dnsmasq configuration file.\n" max: null metavar: null min: null mutable: false name: dnsmasq_config_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.network.linux_net.LinuxBridgeInterfaceDriver deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: linuxnet_interface_driver help: "\nThis is the class used as the ethernet device driver for linuxnet bridge\n\ operations. The default value should be all you need for most cases, but if\ \ you\nwish to use a customized class, set this option to the full dot-separated\n\ import path for that class.\n\nPossible values:\n\n Any string representing\ \ a dot-separated class path that Nova can import.\n" max: null metavar: null min: null mutable: false name: linuxnet_interface_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: br-int deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: linuxnet_ovs_integration_bridge help: "\nThe name of the Open vSwitch bridge that is used with linuxnet when\ \ connecting\nwith Open vSwitch.\"\n\nPossible values:\n\n Any string representing\ \ a valid bridge name.\n" max: null metavar: null min: null mutable: false name: linuxnet_ovs_integration_bridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: send_arp_for_ha help: "\nWhen True, when a device starts up, and upon binding floating IP addresses,\ \ arp\nmessages will be sent to ensure that the arp caches on the compute\ \ hosts are\nup-to-date.\n\nRelated options:\n\n send_arp_for_ha_count\n" max: null metavar: null min: null mutable: false name: send_arp_for_ha namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: send_arp_for_ha_count help: "\nWhen arp messages are configured to be sent, they will be sent with\ \ the count\nset to the value of this option. Of course, if this is set to\ \ zero, no arp\nmessages will be sent.\n\nPossible values:\n\n Any integer\ \ greater than or equal to 0\n\nRelated options:\n\n send_arp_for_ha\n" max: null metavar: null min: null mutable: false name: send_arp_for_ha_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_single_default_gateway help: ' When set to True, only the firt nic of a VM will get its default gateway from the DHCP server. ' max: null metavar: null min: null mutable: false name: use_single_default_gateway namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - all deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: forward_bridge_interface help: "\nOne or more interfaces that bridges can forward traffic to. If any\ \ of the items\nin this list is the special keyword 'all', then all traffic\ \ will be forwarded.\n\nPossible values:\n\n A list of zero or more interface\ \ names, or the word 'all'.\n" max: null metavar: null min: null mutable: false name: forward_bridge_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: $my_ip deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_host help: "\nThis option determines the IP address for the network metadata API\ \ server.\n\nPossible values:\n\n * Any valid IP address. The default is\ \ the address of the Nova API server.\n\nRelated options:\n\n * metadata_port\n" max: null metavar: null min: null mutable: false name: metadata_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 8775 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_port help: "\nThis option determines the port used for the metadata API server.\n\ \nRelated options:\n\n * metadata_host\n" max: 65535 metavar: null min: 0 mutable: false name: metadata_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: iptables_top_regex help: "\nThis expression, if defined, will select any matching iptables rules\ \ and place\nthem at the top when applying metadata changes to the rules.\n\ \nPossible values:\n\n * Any string representing a valid regular expression,\ \ or an empty string\n\nRelated options:\n\n * iptables_bottom_regex\n" max: null metavar: null min: null mutable: false name: iptables_top_regex namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: iptables_bottom_regex help: "\nThis expression, if defined, will select any matching iptables rules\ \ and place\nthem at the bottom when applying metadata changes to the rules.\n\ \nPossible values:\n\n * Any string representing a valid regular expression,\ \ or an empty string\n\nRelated options:\n\n * iptables_top_regex\n" max: null metavar: null min: null mutable: false name: iptables_bottom_regex namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: DROP deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: iptables_drop_action help: "\nBy default, packets that do not pass the firewall are DROPped. In many\ \ cases,\nthough, an operator may find it more useful to change this from\ \ DROP to REJECT,\nso that the user issuing those packets may have a better\ \ idea as to what's\ngoing on, or LOGDROP in order to record the blocked traffic\ \ before DROPping.\n\nPossible values:\n\n * A string representing an iptables\ \ chain. The default is DROP.\n" max: null metavar: null min: null mutable: false name: iptables_drop_action namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 120 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ovs_vsctl_timeout help: "\nThis option represents the period of time, in seconds, that the ovs_vsctl\ \ calls\nwill wait for a response from the database before timing out. A setting\ \ of 0\nmeans that the utility should wait forever for a response.\n\nPossible\ \ values:\n\n * Any positive integer if a limited timeout is desired, or\ \ zero if the\n calls should wait forever for a response.\n" max: null metavar: null min: 0 mutable: false name: ovs_vsctl_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: fake_network help: ' This option is used mainly in testing to avoid calls to the underlying network utilities. ' max: null metavar: null min: null mutable: false name: fake_network namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ebtables_exec_attempts help: "\nThis option determines the number of times to retry ebtables commands\ \ before\ngiving up. The minimum number of retries is 1.\n\nPossible values:\n\ \n * Any positive integer\n\nRelated options:\n\n * ebtables_retry_interval\n" max: null metavar: null min: 1 mutable: false name: ebtables_exec_attempts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ebtables_retry_interval help: "\nThis option determines the time, in seconds, that the system will sleep\ \ in\nbetween ebtables retries. Note that each successive retry waits a multiple\ \ of\nthis value, so for example, if this is set to the default of 1.0 seconds,\ \ and\nebtables_exec_attempts is 4, after the first failure, the system will\ \ sleep for\n1 * 1.0 seconds, after the second failure it will sleep 2 * 1.0\ \ seconds, and\nafter the third failure it will sleep 3 * 1.0 seconds.\n\n\ Possible values:\n\n * Any non-negative float or integer. Setting this\ \ to zero will result in no\n waiting between attempts.\n\nRelated options:\n\ \n * ebtables_exec_attempts\n" max: null metavar: null min: null mutable: false name: ebtables_retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: flat_injected help: ' This option determines whether the network setup information is injected into the VM before it is booted. While it was originally designed to be used only by nova-network, it is also used by the vmware and xenapi virt drivers to control whether network information is injected into a VM. ' max: null metavar: null min: null mutable: false name: flat_injected namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: flat_network_bridge help: "\nThis option determines the bridge used for simple network interfaces\ \ when no\nbridge is specified in the VM creation request.\n\nPlease note\ \ that this option is only used when using nova-network instead of\nNeutron\ \ in your deployment.\n\nPossible values:\n\n Any string representing a\ \ valid network bridge, such as 'br100'\n\nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: flat_network_bridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 8.8.4.4 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: flat_network_dns help: "\nThis is the address of the DNS server for a simple network. If this\ \ option is\nnot specified, the default of '8.8.4.4' is used.\n\nPlease note\ \ that this option is only used when using nova-network instead of\nNeutron\ \ in your deployment.\n\nPossible values:\n\n Any valid IP address.\n\n\ Related options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: flat_network_dns namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: flat_interface help: "\nThis option is the name of the virtual interface of the VM on which\ \ the bridge\nwill be built. While it was originally designed to be used only\ \ by\nnova-network, it is also used by libvirt for the bridge interface name.\n\ \nPossible values:\n\n Any valid virtual interface name, such as 'eth0'\n" max: null metavar: null min: null mutable: false name: flat_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 100 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: vlan_start help: "\nThis is the VLAN number used for private networks. Note that the when\ \ creating\nthe networks, if the specified number has already been assigned,\ \ nova-network\nwill increment this number until it finds an available VLAN.\n\ \nPlease note that this option is only used when using nova-network instead\ \ of\nNeutron in your deployment. It also will be ignored if the configuration\ \ option\nfor `network_manager` is not set to the default of\n'nova.network.manager.VlanManager'.\n\ \nPossible values:\n\n Any integer between 1 and 4094. Values outside of\ \ that range will raise a\n ValueError exception. Default = 100.\n\nRelated\ \ options:\n\n ``network_manager``, ``use_neutron``\n" max: 4094 metavar: null min: 1 mutable: false name: vlan_start namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. While this option has an effect when using neutron, it incorrectly override the value provided by neutron and should therefore not be used. ' deprecated_since: 15.0.0 dest: vlan_interface help: "\nThis option is the name of the virtual interface of the VM on which\ \ the VLAN\nbridge will be built. While it was originally designed to be used\ \ only by\nnova-network, it is also used by libvirt and xenapi for the bridge\ \ interface\nname.\n\nPlease note that this setting will be ignored in nova-network\ \ if the\nconfiguration option for `network_manager` is not set to the default\ \ of\n'nova.network.manager.VlanManager'.\n\nPossible values:\n\n Any valid\ \ virtual interface name, such as 'eth0'\n" max: null metavar: null min: null mutable: false name: vlan_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: num_networks help: "\nThis option represents the number of networks to create if not explicitly\n\ specified when the network is created. The only time this is used is if a\ \ CIDR\nis specified, but an explicit network_size is not. In that case, the\ \ subnets\nare created by diving the IP address space of the CIDR by num_networks.\ \ The\nresulting subnet sizes cannot be larger than the configuration option\n\ `network_size`; in that event, they are reduced to `network_size`, and a\n\ warning is logged.\n\nPlease note that this option is only used when using\ \ nova-network instead of\nNeutron in your deployment.\n\nPossible values:\n\ \n Any positive integer is technically valid, although there are practical\n\ \ limits based upon available IP address space and virtual interfaces.\ \ The\n default is 1.\n\nRelated options:\n\n ``use_neutron``, ``network_size``\n" max: null metavar: null min: 1 mutable: false name: num_networks namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: $my_ip deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: vpn_ip help: "\nThis is the public IP address for the cloudpipe VPN servers. It defaults\ \ to the\nIP address of the host.\n\nPlease note that this option is only\ \ used when using nova-network instead of\nNeutron in your deployment. It\ \ also will be ignored if the configuration option\nfor `network_manager`\ \ is not set to the default of\n'nova.network.manager.VlanManager'.\n\nPossible\ \ values:\n\n Any valid IP address. The default is $my_ip, the IP address\ \ of the VM.\n\nRelated options:\n\n ``network_manager``, ``use_neutron``,\ \ ``vpn_start``\n" max: null metavar: null min: null mutable: false name: vpn_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1000 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: vpn_start help: "\nThis is the port number to use as the first VPN port for private networks.\n\ \nPlease note that this option is only used when using nova-network instead\ \ of\nNeutron in your deployment. It also will be ignored if the configuration\ \ option\nfor `network_manager` is not set to the default of\n'nova.network.manager.VlanManager',\ \ or if you specify a value the 'vpn_start'\nparameter when creating a network.\n\ \nPossible values:\n\n Any integer representing a valid port number. The\ \ default is 1000.\n\nRelated options:\n\n ``use_neutron``, ``vpn_ip``,\ \ ``network_manager``\n" max: 65535 metavar: null min: 0 mutable: false name: vpn_start namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 256 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: network_size help: "\nThis option determines the number of addresses in each private subnet.\n\ \nPlease note that this option is only used when using nova-network instead\ \ of\nNeutron in your deployment.\n\nPossible values:\n\n Any positive\ \ integer that is less than or equal to the available network\n size. Note\ \ that if you are creating multiple networks, they must all fit in\n the\ \ available IP address space. The default is 256.\n\nRelated options:\n\n\ \ ``use_neutron``, ``num_networks``\n" max: null metavar: null min: 1 mutable: false name: network_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: fd00::/48 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: fixed_range_v6 help: "\nThis option determines the fixed IPv6 address block when creating a\ \ network.\n\nPlease note that this option is only used when using nova-network\ \ instead of\nNeutron in your deployment.\n\nPossible values:\n\n Any valid\ \ IPv6 CIDR. The default value is \"fd00::/48\".\n\nRelated options:\n\n \ \ ``use_neutron``\n" max: null metavar: null min: null mutable: false name: fixed_range_v6 namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: gateway help: "\nThis is the default IPv4 gateway. It is used only in the testing suite.\n\ \nPlease note that this option is only used when using nova-network instead\ \ of\nNeutron in your deployment.\n\nPossible values:\n\n Any valid IP\ \ address.\n\nRelated options:\n\n ``use_neutron``, ``gateway_v6``\n" max: null metavar: null min: null mutable: false name: gateway namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: gateway_v6 help: "\nThis is the default IPv6 gateway. It is used only in the testing suite.\n\ \nPlease note that this option is only used when using nova-network instead\ \ of\nNeutron in your deployment.\n\nPossible values:\n\n Any valid IP\ \ address.\n\nRelated options:\n\n ``use_neutron``, ``gateway``\n" max: null metavar: null min: null mutable: false name: gateway_v6 namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: cnt_vpn_clients help: "\nThis option represents the number of IP addresses to reserve at the\ \ top of the\naddress range for VPN clients. It also will be ignored if the\ \ configuration\noption for `network_manager` is not set to the default of\n\ 'nova.network.manager.VlanManager'.\n\nPossible values:\n\n Any integer,\ \ 0 or greater. The default is 0.\n\nRelated options:\n\n ``use_neutron``,\ \ ``network_manager``\n" max: null metavar: null min: 0 mutable: false name: cnt_vpn_clients namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: fixed_ip_disassociate_timeout help: "\nThis is the number of seconds to wait before disassociating a deallocated\ \ fixed\nIP address. This is only used with the nova-network service, and\ \ has no effect\nwhen using neutron for networking.\n\nPossible values:\n\n\ \ Any integer, zero or greater. The default is 600 (10 minutes).\n\nRelated\ \ options:\n\n ``use_neutron``\n" max: null metavar: null min: 0 mutable: false name: fixed_ip_disassociate_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: create_unique_mac_address_attempts help: "\nThis option determines how many times nova-network will attempt to\ \ create a\nunique MAC address before giving up and raising a\n`VirtualInterfaceMacAddressException`\ \ error.\n\nPossible values:\n\n Any positive integer. The default is 5.\n\ \nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: 1 mutable: false name: create_unique_mac_address_attempts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: teardown_unused_network_gateway help: "\nDetermines whether unused gateway devices, both VLAN and bridge, are\ \ deleted if\nthe network is in nova-network VLAN mode and is multi-hosted.\n\ \nRelated options:\n\n ``use_neutron``, ``vpn_ip``, ``fake_network``\n" max: null metavar: null min: null mutable: false name: teardown_unused_network_gateway namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: force_dhcp_release help: "\nWhen this option is True, a call is made to release the DHCP for the\ \ instance\nwhen that instance is terminated.\n\nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: force_dhcp_release namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: update_dns_entries help: "\nWhen this option is True, whenever a DNS entry must be updated, a fanout\ \ cast\nmessage is sent to all network hosts to update their DNS entries in\ \ multi-host\nmode.\n\nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: update_dns_entries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: -1 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: dns_update_periodic_interval help: "\nThis option determines the time, in seconds, to wait between refreshing\ \ DNS\nentries for the network.\n\nPossible values:\n\n Either -1 (default),\ \ or any positive integer. A negative value will disable\n the updates.\n\ \nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: -1 mutable: false name: dns_update_periodic_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: novalocal deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: dhcp_domain help: "\nThis option allows you to specify the domain for the DHCP server.\n\ \nPossible values:\n\n Any string that is a valid domain name.\n\nRelated\ \ options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: dhcp_domain namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.network.l3.LinuxNetL3 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: l3_lib help: "\nThis option allows you to specify the L3 management library to be used.\n\ \nPossible values:\n\n Any dot-separated string that represents the import\ \ path to an L3\n networking library.\n\nRelated options:\n\n ``use_neutron``\n" max: null metavar: null min: null mutable: false name: l3_lib namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: null deprecated_since: '2014.2' dest: share_dhcp_address help: ' THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK. If True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the VMs on the same host. The use of this configuration has been deprecated and may be removed in any release after Mitaka. It is recommended that instead of relying on this option, an explicit value should be passed to ''create_networks()'' as a keyword argument with the name ''share_address''. ' max: null metavar: null min: null mutable: false name: share_dhcp_address namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: use_neutron help: Whether to use Neutron or Nova Network as the back end for networking. Defaults to False (indicating Nova network).Set to True to use neutron. max: null metavar: null min: null mutable: false name: use_neutron namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: ldap://ldap.example.com:389 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_url help: ' URL for LDAP server which will store DNS entries Possible values: * A valid LDAP URL representing the server ' max: null metavar: null min: null mutable: false name: ldap_dns_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: uid=admin,ou=people,dc=example,dc=org deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_user help: Bind user for LDAP server max: null metavar: null min: null mutable: false name: ldap_dns_user namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: password deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_password help: Bind user's password for LDAP server max: null metavar: null min: null mutable: false name: ldap_dns_password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: hostmaster@example.org deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_soa_hostmaster help: ' Hostmaster for LDAP DNS driver Statement of Authority Possible values: * Any valid string representing LDAP DNS hostmaster. ' max: null metavar: null min: null mutable: false name: ldap_dns_soa_hostmaster namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - dns.example.org deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_servers help: ' DNS Servers for LDAP DNS driver Possible values: * A valid URL representing a DNS server ' max: null metavar: null min: null mutable: false name: ldap_dns_servers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: ou=hosts,dc=example,dc=org deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_base_dn help: ' Base distinguished name for the LDAP search query This option helps to decide where to look up the host in LDAP. ' max: null metavar: null min: null mutable: false name: ldap_dns_base_dn namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1800 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_soa_refresh help: ' Refresh interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server waits before requesting for primary DNS server''s current SOA record. If the records are different, secondary DNS server will request a zone transfer from primary. NOTE: Lower values would cause more traffic. ' max: null metavar: null min: null mutable: false name: ldap_dns_soa_refresh namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_soa_retry help: ' Retry interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server should wait, if an attempt to transfer zone failed during the previous refresh interval. ' max: null metavar: null min: null mutable: false name: ldap_dns_soa_retry namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 86400 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_soa_expiry help: ' Expiry interval (in seconds) for LDAP DNS driver Start of Authority Time interval, a secondary/slave DNS server holds the information before it is no longer considered authoritative. ' max: null metavar: null min: null mutable: false name: ldap_dns_soa_expiry namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 7200 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ldap_dns_soa_minimum help: ' Minimum interval (in seconds) for LDAP DNS driver Start of Authority It is Minimum time-to-live applies for all resource records in the zone file. This value is supplied to other servers how long they should keep the data in cache. ' max: null metavar: null min: null mutable: false name: ldap_dns_soa_minimum namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: network deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There is no need to let users choose the RPC topic for all services - there is little gain from this. Furthermore, it makes it really easy to break Nova by using this option. ' deprecated_since: 15.0.0 dest: network_topic help: The topic network nodes listen on max: null metavar: null min: null mutable: false name: network_topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: multi_host help: ' Default value for multi_host in networks. nova-network service can operate in a multi-host or single-host mode. In multi-host mode each compute node runs a copy of nova-network and the instances on that compute node use the compute node as a gateway to the Internet. Where as in single-host mode, a central server runs the nova-network service. All compute nodes forward traffic from the instances to the cloud controller which then forwards traffic to the Internet. If this options is set to true, some rpc network calls will be sent directly to host. Note that this option is only used when using nova-network instead of Neutron in your deployment. Related options: * use_neutron ' max: null metavar: null min: null mutable: false name: multi_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: nova.network.linux_net deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: network_driver help: ' Driver to use for network creation. Network driver initializes (creates bridges and so on) only when the first VM lands on a host node. All network managers configure the network using network drivers. The driver is not tied to any particular network manager. The default Linux driver implements vlans, bridges, and iptables rules using linux utilities. Note that this option is only used when using nova-network instead of Neutron in your deployment. Related options: * use_neutron ' max: null metavar: null min: null mutable: false name: network_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: firewall_driver help: "\nFirewall driver to use with ``nova-network`` service.\n\nThis option\ \ only applies when using the ``nova-network`` service. When using\nanother\ \ networking services, such as Neutron, this should be to set to the\n``nova.virt.firewall.NoopFirewallDriver``.\n\ \nIf unset (the default), this will default to the hypervisor-specified\n\ default driver.\n\nPossible values:\n\n* nova.virt.firewall.IptablesFirewallDriver\n\ * nova.virt.firewall.NoopFirewallDriver\n* nova.virt.libvirt.firewall.IptablesFirewallDriver\n\ * [...]\n\nRelated options:\n\n* ``use_neutron``: This must be set to ``False``\ \ to enable ``nova-network``\n networking\n" max: null metavar: null min: null mutable: false name: firewall_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_same_net_traffic help: "\nDetermine whether to allow network traffic from same network.\n\nWhen\ \ set to true, hosts on the same subnet are not filtered and are allowed\n\ to pass all types of traffic between them. On a flat network, this allows\n\ all instances from all projects unfiltered communication. With VLAN\nnetworking,\ \ this allows access between instances within the same project.\n\nThis option\ \ only applies when using the ``nova-network`` service. When using\nanother\ \ networking services, such as Neutron, security groups or other\napproaches\ \ should be used.\n\nPossible values:\n\n* True: Network traffic should be\ \ allowed pass between all instances on the\n same network, regardless of\ \ their tenant and security policies\n* False: Network traffic should not\ \ be allowed pass between instances unless\n it is unblocked in a security\ \ group\n\nRelated options:\n\n* ``use_neutron``: This must be set to ``False``\ \ to enable ``nova-network``\n networking\n* ``firewall_driver``: This must\ \ be set to\n ``nova.virt.libvirt.firewall.IptablesFirewallDriver`` to ensure\ \ the\n libvirt firewall driver is enabled.\n" max: null metavar: null min: null mutable: false name: allow_same_net_traffic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: record help: ' Filename that will be used for storing websocket frames received and sent by a proxy service (like VNC, spice, serial) running on this host. If this is not set, no recording will be done. ' max: null metavar: null min: null mutable: false name: record namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: daemon help: Run as a background process. max: null metavar: null min: null mutable: false name: daemon namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ssl_only help: Disallow non-encrypted connections. max: null metavar: null min: null mutable: false name: ssl_only namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: source_is_ipv6 help: Set to True if source host is addressed with IPv6. max: null metavar: null min: null mutable: false name: source_is_ipv6 namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: self.pem deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cert help: Path to SSL certificate file. max: null metavar: null min: null mutable: false name: cert namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: key help: SSL key file (if separate from cert). max: null metavar: null min: null mutable: false name: key namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /usr/share/spice-html5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: web help: ' Path to directory with content which will be served by a web server. ' max: null metavar: null min: null mutable: false name: web namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /opt/stack/oslo.config/.tox/venv/lib/python2.7/site-packages deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pybasedir help: ' 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`` ' max: null metavar: null min: null mutable: false name: pybasedir namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /opt/stack/oslo.config/.tox/venv/local/bin deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: bindir help: ' 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. ' max: null metavar: null min: null mutable: false name: bindir namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $pybasedir deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: state_path help: ' 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``. ' max: null metavar: null min: null mutable: false name: state_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: report_interval help: "\nNumber of seconds indicating how frequently the state of services on\ \ a\ngiven hypervisor is reported. Nova needs to know this to determine the\n\ overall health of the deployment.\n\nRelated Options:\n\n* service_down_time\n\ \ report_interval should be less than service_down_time. If service_down_time\n\ \ is less than report_interval, services will routinely be considered down,\n\ \ because they report in too rarely.\n" max: null metavar: null min: null mutable: false name: report_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: service_down_time help: ' Maximum time in seconds since last check-in for up service Each compute node periodically updates their database status based on the specified report interval. If the compute node hasn''t updated the status for more than service_down_time, then the compute node is considered down. Related Options: * report_interval (service_down_time should not be less than report_interval) ' max: null metavar: null min: null mutable: false name: service_down_time namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: periodic_enable help: ' Enable periodic tasks. If set to true, this option allows services to periodically run tasks on the manager. In case of running multiple schedulers or conductors you may want to run periodic tasks on only one host - in this case disable this option for all hosts but one. ' max: null metavar: null min: null mutable: false name: periodic_enable namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: periodic_fuzzy_delay help: ' Number of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. When compute workers are restarted in unison across a cluster, they all end up running the periodic tasks at the same time causing problems for the external services. To mitigate this behavior, periodic_fuzzy_delay option allows you to introduce a random initial delay when starting the periodic task scheduler. Possible Values: * Any positive integer (in seconds) * 0 : disable the random delay ' max: null metavar: null min: 0 mutable: false name: periodic_fuzzy_delay namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: - osapi_compute - metadata deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled_apis help: List of APIs to be enabled by default. max: null metavar: null min: null mutable: false name: enabled_apis namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled_ssl_apis help: ' List of APIs with enabled SSL. Nova provides SSL support for the API servers. enabled_ssl_apis option allows configuring the SSL support. ' max: null metavar: null min: null mutable: false name: enabled_ssl_apis namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: osapi_compute_listen help: ' IP address on which the OpenStack API will listen. The OpenStack API service listens on this IP address for incoming requests. ' max: null metavar: null min: null mutable: false name: osapi_compute_listen namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 8774 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: osapi_compute_listen_port help: ' Port on which the OpenStack API will listen. The OpenStack API service listens on this port number for incoming requests. ' max: 65535 metavar: null min: 0 mutable: false name: osapi_compute_listen_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: osapi_compute_workers help: ' Number of workers for OpenStack API service. The default will be the number of CPUs available. OpenStack API services can be configured to run as multi-process (workers). This overcomes the problem of reduction in throughput when API request concurrency increases. OpenStack API service will run in the specified number of processes. Possible Values: * Any positive integer * None (default value) ' max: null metavar: null min: 1 mutable: false name: osapi_compute_workers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_listen help: ' IP address on which the metadata API will listen. The metadata API service listens on this IP address for incoming requests. ' max: null metavar: null min: null mutable: false name: metadata_listen namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 8775 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_listen_port help: ' Port on which the metadata API will listen. The metadata API service listens on this port number for incoming requests. ' max: 65535 metavar: null min: 0 mutable: false name: metadata_listen_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_workers help: ' Number of workers for metadata service. If not specified the number of available CPUs will be used. The metadata service can be configured to run as multi-process (workers). This overcomes the problem of reduction in throughput when API request concurrency increases. The metadata service will run in the specified number of processes. Possible Values: * Any positive integer * None (default value) ' max: null metavar: null min: 1 mutable: false name: metadata_workers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - nova.network.manager.FlatManager - nova.network.manager.FlatDHCPManager - nova.network.manager.VlanManager default: nova.network.manager.VlanManager deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: network_manager help: Full class name for the Manager for network max: null metavar: null min: null mutable: false name: network_manager namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - db - mc default: db deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: servicegroup_driver help: "\nThis option specifies the driver to be used for the servicegroup service.\n\ \nServiceGroup API in nova enables checking status of a compute node. When\ \ a\ncompute worker running the nova-compute daemon starts, it calls the join\ \ API\nto join the compute group. Services like nova scheduler can query the\n\ ServiceGroup API to check if a node is alive. Internally, the ServiceGroup\n\ client driver automatically updates the compute worker status. There are\n\ multiple backend implementations for this service: Database ServiceGroup driver\n\ and Memcache ServiceGroup driver.\n\nPossible Values:\n\n * db : Database\ \ ServiceGroup driver\n * mc : Memcache ServiceGroup driver\n\nRelated\ \ Options:\n\n * service_down_time (maximum time since last check-in for\ \ up service)\n" max: null metavar: null min: null mutable: false name: servicegroup_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value api: help: ' Options under this group are used to define Nova API. ' opts: - advanced: false choices: - keystone - noauth2 default: keystone deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: auth_strategy deprecated_reason: null deprecated_since: null dest: auth_strategy help: ' This determines the strategy to use for authentication: keystone or noauth2. ''noauth2'' is designed for testing only, as it does no actual credential checking. ''noauth2'' provides administrative credentials only if ''admin'' is specified as the username. ' max: null metavar: null min: null mutable: false name: auth_strategy namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_forwarded_for deprecated_reason: null deprecated_since: null dest: use_forwarded_for help: ' When True, the ''X-Forwarded-For'' header is treated as the canonical remote address. When False (the default), the ''remote_address'' header is used. You should only enable this if you have an HTML sanitizing proxy. ' max: null metavar: null min: null mutable: false name: use_forwarded_for namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: config_drive_skip_versions deprecated_reason: null deprecated_since: null dest: config_drive_skip_versions help: ' When gathering the existing metadata for a config drive, the EC2-style metadata is returned for all versions that don''t appear in this option. As of the Liberty release, the available versions are: * 1.0 * 2007-01-19 * 2007-03-01 * 2007-08-29 * 2007-10-10 * 2007-12-15 * 2008-02-01 * 2008-09-01 * 2009-04-04 The option is in the format of a single string, with each version separated by a space. Possible values: * Any string that represents zero or more versions, separated by spaces. ' max: null metavar: null min: null mutable: false name: config_drive_skip_versions namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_providers deprecated_reason: null deprecated_since: null dest: vendordata_providers help: "\nA list of vendordata providers.\n\nvendordata providers are how deployers\ \ can provide metadata via configdrive\nand metadata that is specific to their\ \ deployment. There are currently two\nsupported providers: StaticJSON and\ \ DynamicJSON.\n\nStaticJSON reads a JSON file configured by the flag vendordata_jsonfile_path\n\ and places the JSON from that file into vendor_data.json and\nvendor_data2.json.\n\ \nDynamicJSON is configured via the vendordata_dynamic_targets flag, which\ \ is\ndocumented separately. For each of the endpoints specified in that flag,\ \ a\nsection is added to the vendor_data2.json.\n\nFor more information on\ \ the requirements for implementing a vendordata\ndynamic endpoint, please\ \ see the vendordata.rst file in the nova developer\nreference.\n\nPossible\ \ values:\n\n* A list of vendordata providers, with StaticJSON and DynamicJSON\ \ being\n current options.\n\nRelated options:\n\n* vendordata_dynamic_targets\n\ * vendordata_dynamic_ssl_certfile\n* vendordata_dynamic_connect_timeout\n\ * vendordata_dynamic_read_timeout\n* vendordata_dynamic_failure_fatal\n" max: null metavar: null min: null mutable: false name: vendordata_providers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_dynamic_targets deprecated_reason: null deprecated_since: null dest: vendordata_dynamic_targets help: ' A list of targets for the dynamic vendordata provider. These targets are of the form @. The dynamic vendordata provider collects metadata by contacting external REST services and querying them for information about the instance. This behaviour is documented in the vendordata.rst file in the nova developer reference. ' max: null metavar: null min: null mutable: false name: vendordata_dynamic_targets namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_dynamic_ssl_certfile deprecated_reason: null deprecated_since: null dest: vendordata_dynamic_ssl_certfile help: ' 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 * vendordata_dynamic_failure_fatal ' max: null metavar: null min: null mutable: false name: vendordata_dynamic_ssl_certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_dynamic_connect_timeout deprecated_reason: null deprecated_since: null dest: vendordata_dynamic_connect_timeout help: "\nMaximum wait time for an external REST service to connect.\n\nPossible\ \ values:\n\n* Any integer with a value greater than three (the TCP packet\ \ retransmission\n timeout). Note that instance start may be blocked during\ \ this wait time,\n so this value should be kept small.\n\nRelated options:\n\ \n* vendordata_providers\n* vendordata_dynamic_targets\n* vendordata_dynamic_ssl_certfile\n\ * vendordata_dynamic_read_timeout\n* vendordata_dynamic_failure_fatal\n" max: null metavar: null min: 3 mutable: false name: vendordata_dynamic_connect_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_dynamic_read_timeout deprecated_reason: null deprecated_since: null dest: vendordata_dynamic_read_timeout help: "\nMaximum wait time for an external REST service to return data once\ \ connected.\n\nPossible values:\n\n* Any integer. Note that instance start\ \ is blocked during this wait time,\n so this value should be kept small.\n\ \nRelated options:\n\n* vendordata_providers\n* vendordata_dynamic_targets\n\ * vendordata_dynamic_ssl_certfile\n* vendordata_dynamic_connect_timeout\n\ * vendordata_dynamic_failure_fatal\n" max: null metavar: null min: 0 mutable: false name: vendordata_dynamic_read_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vendordata_dynamic_failure_fatal help: ' Should failures to fetch dynamic vendordata be fatal to instance boot? Related options: * vendordata_providers * vendordata_dynamic_targets * vendordata_dynamic_ssl_certfile * vendordata_dynamic_connect_timeout * vendordata_dynamic_read_timeout ' max: null metavar: null min: null mutable: false name: vendordata_dynamic_failure_fatal namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 15 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: metadata_cache_expiration deprecated_reason: null deprecated_since: null dest: metadata_cache_expiration help: ' This option is the time (in seconds) to cache metadata. When set to 0, metadata caching is disabled entirely; this is generally not recommended for performance reasons. Increasing this setting should improve response times of the metadata API when under heavy load. Higher values may increase memory usage, and result in longer times for host metadata changes to take effect. ' max: null metavar: null min: 0 mutable: false name: metadata_cache_expiration namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vendordata_jsonfile_path deprecated_reason: null deprecated_since: null dest: vendordata_jsonfile_path help: "\nCloud providers may store custom data in vendor data file that will\ \ then be\navailable to the instances via the metadata service, and to the\ \ rendering of\nconfig-drive. The default class for this, JsonFileVendorData,\ \ loads this\ninformation from a JSON file, whose path is configured by this\ \ option. If\nthere is no path set by this option, the class returns an empty\ \ dictionary.\n\nPossible values:\n\n* Any string representing the path to\ \ the data file, or an empty string\n (default).\n" max: null metavar: null min: null mutable: false name: vendordata_jsonfile_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1000 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: osapi_max_limit deprecated_reason: null deprecated_since: null dest: max_limit help: ' As a query can potentially return many thousands of items, you can limit the maximum number of items in a single response by setting this option. ' max: null metavar: null min: 0 mutable: false name: max_limit namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: osapi_compute_link_prefix deprecated_reason: null deprecated_since: null dest: compute_link_prefix help: ' This string is prepended to the normal URL that is returned in links to the OpenStack Compute API. If it is empty (the default), the URLs are returned unchanged. Possible values: * Any string, including an empty string (the default). ' max: null metavar: null min: null mutable: false name: compute_link_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: osapi_glance_link_prefix deprecated_reason: null deprecated_since: null dest: glance_link_prefix help: ' 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). ' max: null metavar: null min: null mutable: false name: glance_link_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: allow_instance_snapshots deprecated_reason: null deprecated_since: null dest: allow_instance_snapshots help: ' Operators can turn off the ability for a user to take snapshots of their instances by setting this option to False. When disabled, any attempt to take a snapshot will result in a HTTP 400 response ("Bad Request"). ' max: null metavar: null min: null mutable: false name: allow_instance_snapshots namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - building deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: osapi_hide_server_address_states deprecated_reason: null deprecated_since: null dest: hide_server_address_states help: "\nThis option is a list of all instance states for which network address\n\ information should not be returned from the API.\n\nPossible values:\n\n \ \ A list of strings, where each string is a valid VM state, as defined in\n\ \ nova/compute/vm_states.py. As of the Newton release, they are:\n\n* \"\ active\"\n* \"building\"\n* \"paused\"\n* \"suspended\"\n* \"stopped\"\n*\ \ \"rescued\"\n* \"resized\"\n* \"soft-delete\"\n* \"deleted\"\n* \"error\"\ \n* \"shelved\"\n* \"shelved_offloaded\"\n" max: null metavar: null min: null mutable: false name: hide_server_address_states namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: /usr/sbin/fping deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: fping_path deprecated_reason: null deprecated_since: null dest: fping_path help: The full path to the fping binary. max: null metavar: null min: null mutable: false name: fping_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_neutron_default_nets deprecated_reason: null deprecated_since: null dest: use_neutron_default_nets help: ' When True, the TenantNetworkController will query the Neutron API to get the default networks to use. Related options: * neutron_default_tenant_id ' max: null metavar: null min: null mutable: false name: use_neutron_default_nets namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: default deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: neutron_default_tenant_id deprecated_reason: null deprecated_since: null dest: neutron_default_tenant_id help: ' 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 ' max: null metavar: null min: null mutable: false name: neutron_default_tenant_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: enable_instance_password deprecated_reason: null deprecated_since: null dest: enable_instance_password help: ' Enables returning of the instance password by the relevant server API calls such as create, rebuild, evacuate, or rescue. If the hypervisor does not support password injection, then the password returned will not be correct, so if your hypervisor does not support password injection, set this to False. ' max: null metavar: null min: null mutable: false name: enable_instance_password namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value api_database: help: ' The *Nova API Database* is a separate database which is used for information which is used across *cells*. This database is mandatory since the Mitaka release (13.0.0). ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection help: The SQLAlchemy connection string to use to connect to the database. max: null metavar: null min: null mutable: false name: connection namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sqlite_synchronous help: If True, SQLite uses synchronous mode. max: null metavar: null min: null mutable: false name: sqlite_synchronous namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: slave_connection help: The SQLAlchemy connection string to use to connect to the slave database. max: null metavar: null min: null mutable: false name: slave_connection namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: TRADITIONAL deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mysql_sql_mode help: 'The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=' max: null metavar: null min: null mutable: false name: mysql_sql_mode namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: idle_timeout help: Timeout before idle SQL connections are reaped. max: null metavar: null min: null mutable: false name: idle_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_pool_size help: Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. max: null metavar: null min: null mutable: false name: max_pool_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_retries help: Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. max: null metavar: null min: null mutable: false name: max_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: retry_interval help: Interval between retries of opening a SQL connection. max: null metavar: null min: null mutable: false name: retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_overflow help: If set, use this value for max_overflow with SQLAlchemy. max: null metavar: null min: null mutable: false name: max_overflow namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_debug help: 'Verbosity of SQL debugging information: 0=None, 100=Everything.' max: null metavar: null min: null mutable: false name: connection_debug namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_trace help: Add Python stack traces to SQL as comment strings. max: null metavar: null min: null mutable: false name: connection_trace namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_timeout help: If set, use this value for pool_timeout with SQLAlchemy. max: null metavar: null min: null mutable: false name: pool_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value barbican: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: barbican_endpoint help: 'Use this endpoint to connect to Barbican, for example: "http://localhost:9311/"' max: null metavar: null min: null mutable: false name: barbican_endpoint namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: barbican_api_version help: 'Version of the Barbican API, for example: "v1"' max: null metavar: null min: null mutable: false name: barbican_api_version namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: http://localhost:5000/v3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_endpoint help: Use this endpoint to connect to Keystone max: null metavar: null min: null mutable: false name: auth_endpoint namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: retry_delay help: Number of seconds to wait before retrying poll for key creation completion max: null metavar: null min: null mutable: false name: retry_delay namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: number_of_retries help: Number of times to retry poll for key creation completion max: null metavar: null min: null mutable: false name: number_of_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value cache: help: null opts: - advanced: false choices: null default: cache.oslo deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: config_prefix help: Prefix for building the configuration dictionary for the cache region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. max: null metavar: null min: null mutable: false name: config_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: expiration_time help: Default TTL, in seconds, for any cached item in the dogpile.cache region. This applies to any cached method that doesn't have an explicit cache expiration time defined for it. max: null metavar: null min: null mutable: false name: expiration_time namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: dogpile.cache.null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: backend help: Dogpile.cache backend module. It is recommended that Memcache or Redis (dogpile.cache.redis) be used in production deployments. For eventlet-based or highly threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is recommended. For low thread servers, dogpile.cache.memcached is recommended. Test environments with a single instance of the server can use the dogpile.cache.memory backend. max: null metavar: null min: null mutable: false name: backend namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: backend_argument help: 'Arguments supplied to the backend module. Specify this option once per argument to be passed to the dogpile.cache backend. Example format: ":".' max: null metavar: null min: null mutable: false name: backend_argument namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: multi valued - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: proxies help: Proxy classes to import that will affect the way the dogpile.cache backend functions. See the dogpile.cache documentation on changing-backend-behavior. max: null metavar: null min: null mutable: false name: proxies namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: Global toggle for caching. max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: debug_cache_backend help: Extra debugging from the cache backend (cache keys, get/set/delete/etc calls). This is only really useful if you need to see the specific cache-backend get/set/delete calls with the keys/values. Typically this should be left set to false. max: null metavar: null min: null mutable: false name: debug_cache_backend namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - localhost:11211 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_servers help: Memcache servers in the format of "host:port". (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). max: null metavar: null min: null mutable: false name: memcache_servers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_dead_retry help: Number of seconds memcached server is considered dead before it is tried again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). max: null metavar: null min: null mutable: false name: memcache_dead_retry namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_socket_timeout help: Timeout in seconds for every call to a server. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only). max: null metavar: null min: null mutable: false name: memcache_socket_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_maxsize help: Max total number of open connections to every memcached server. (oslo_cache.memcache_pool backend only). max: null metavar: null min: null mutable: false name: memcache_pool_maxsize namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_unused_timeout help: Number of seconds a connection to memcached is held unused in the pool before it is closed. (oslo_cache.memcache_pool backend only). max: null metavar: null min: null mutable: false name: memcache_pool_unused_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_connection_get_timeout help: Number of seconds that an operation will wait to get a memcache client connection. max: null metavar: null min: null mutable: false name: memcache_pool_connection_get_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value cells: help: ' Cells options allow you to use cells functionality in openstack deployment. Note that the options in this group are only for cells v1 functionality, which is considered experimental and not recommended for new deployments. Cells v1 is being replaced with cells v2, which starting in the 15.0.0 Ocata release is required and all Nova deployments will be at least a cells v2 cell of one. ' opts: - advanced: false choices: null default: cells deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' Configurable RPC topics provide little value and can result in a wide variety of errors. They should not be used. ' deprecated_since: 15.0.0 dest: topic help: ' Topic. This is the message queue topic that cells nodes listen on. It is used when the cells service is started up to configure the queue, and whenever an RPC call to the scheduler is made. Possible values: * cells: This is the recommended and the default value. ' max: null metavar: null min: null mutable: false name: topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enable help: "\nEnable cell v1 functionality.\n\nNote that cells v1 is considered experimental\ \ and not recommended for new\nNova deployments. Cells v1 is being replaced\ \ by cells v2 which starting in\nthe 15.0.0 Ocata release, all Nova deployments\ \ are at least a cells v2 cell\nof one. Setting this option, or any other\ \ options in the [cells] group, is\nnot required for cells v2.\n\nWhen this\ \ functionality is enabled, it lets you to scale an OpenStack\nCompute cloud\ \ in a more distributed fashion without having to use\ncomplicated technologies\ \ like database and message queue clustering.\nCells are configured as a tree.\ \ The top-level cell should have a host\nthat runs a nova-api service, but\ \ no nova-compute services. Each\nchild cell should run all of the typical\ \ nova-* services in a regular\nCompute cloud except for nova-api. You can\ \ think of cells as a normal\nCompute deployment in that each cell has its\ \ own database server and\nmessage queue broker.\n\nRelated options:\n\n*\ \ name: A unique cell name must be given when this functionality\n is enabled.\n\ * cell_type: Cell type should be defined for all cells.\n" max: null metavar: null min: null mutable: false name: enable namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: nova deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: name help: "\nName of the current cell.\n\nThis value must be unique for each cell.\ \ Name of a cell is used as\nits id, leaving this option unset or setting\ \ the same name for\ntwo or more cells may cause unexpected behaviour.\n\n\ Related options:\n\n* enabled: This option is meaningful only when cells service\n\ \ is enabled\n" max: null metavar: null min: null mutable: false name: name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - hypervisor=xenserver;kvm - os=linux;windows deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: capabilities help: "\nCell capabilities.\n\nList of arbitrary key=value pairs defining capabilities\ \ of the\ncurrent cell to be sent to the parent cells. These capabilities\n\ are intended to be used in cells scheduler filters/weighers.\n\nPossible values:\n\ \n* key=value pairs list for example;\n ``hypervisor=xenserver;kvm,os=linux;windows``\n" max: null metavar: null min: null mutable: false name: capabilities namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: call_timeout help: ' 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: * An integer, corresponding to the interval time in seconds. ' max: null metavar: null min: 0 mutable: false name: call_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reserve_percent help: "\nReserve percentage\n\nPercentage of cell capacity to hold in reserve,\ \ so the minimum\namount of free resource is considered to be;\n\n min_free\ \ = total * (reserve_percent / 100.0)\n\nThis option affects both memory and\ \ disk utilization.\n\nThe primary purpose of this reserve is to ensure some\ \ space is\navailable for users who want to resize their instance to be larger.\n\ Note that currently once the capacity expands into this reserve\nspace this\ \ option is ignored.\n\nPossible values:\n\n* An integer or float, corresponding\ \ to the percentage of cell capacity to\n be held in reserve.\n" max: null metavar: null min: null mutable: false name: reserve_percent namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: - api - compute default: compute deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cell_type help: "\nType of cell.\n\nWhen cells feature is enabled the hosts in the OpenStack\ \ Compute\ncloud are partitioned into groups. Cells are configured as a tree.\n\ The top-level cell's cell_type must be set to ``api``. All other\ncells are\ \ defined as a ``compute cell`` by default.\n\nRelated option:\n\n* quota_driver:\ \ Disable quota checking for the child cells.\n (nova.quota.NoopQuotaDriver)\n" max: null metavar: null min: null mutable: false name: cell_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mute_child_interval help: ' Mute child interval. Number of seconds after which a lack of capability and capacity update the child cell is to be treated as a mute cell. Then the child cell will be weighed as recommend highly that it be skipped. Possible values: * An integer, corresponding to the interval time in seconds. ' max: null metavar: null min: null mutable: false name: mute_child_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: bandwidth_update_interval help: ' Bandwidth update interval. Seconds between bandwidth usage cache updates for cells. Possible values: * An integer, corresponding to the interval time in seconds. ' max: null metavar: null min: null mutable: false name: bandwidth_update_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_update_sync_database_limit help: ' 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: * An integer, corresponding to a number of instances. ' max: null metavar: null min: null mutable: false name: instance_update_sync_database_limit namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -10000.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mute_weight_multiplier help: ' 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 ' max: null metavar: null min: null mutable: false name: mute_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 10.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ram_weight_multiplier help: ' Ram weight multiplier. Multiplier used for weighing ram. Negative numbers indicate that Compute should stack VMs on one host instead of spreading out new VMs to more hosts in the cell. Possible values: * Numeric multiplier ' max: null metavar: null min: null mutable: false name: ram_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: offset_weight_multiplier help: ' 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 ' max: null metavar: null min: null mutable: false name: offset_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_updated_at_threshold help: "\nInstance updated at threshold\n\nNumber of seconds after an instance\ \ was updated or deleted to\ncontinue to update cells. This option lets cells\ \ manager to only\nattempt to sync instances that have been updated recently.\n\ i.e., a threshold of 3600 means to only update instances that\nhave modified\ \ in the last hour.\n\nPossible values:\n\n* Threshold in seconds\n\nRelated\ \ options:\n\n* This value is used with the ``instance_update_num_instances``\n\ \ value in a periodic task run.\n" max: null metavar: null min: null mutable: false name: instance_updated_at_threshold namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instance_update_num_instances help: "\nInstance update num instances\n\nOn every run of the periodic task,\ \ nova cells manager will attempt to\nsync instance_updated_at_threshold number\ \ of instances. When the\nmanager gets the list of instances, it shuffles\ \ them so that multiple\nnova-cells services do not attempt to sync the same\ \ instances in\nlockstep.\n\nPossible values:\n\n* Positive integer number\n\ \nRelated options:\n\n* This value is used with the ``instance_updated_at_threshold``\n\ \ value in a periodic task run.\n" max: null metavar: null min: null mutable: false name: instance_update_num_instances namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_hop_count help: ' 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 ' max: null metavar: null min: null mutable: false name: max_hop_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: nova.cells.scheduler.CellsScheduler deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler help: ' 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. ' max: null metavar: null min: null mutable: false name: scheduler namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: cells.intercell deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_driver_queue_base help: ' 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. ' max: null metavar: null min: null mutable: false name: rpc_driver_queue_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - nova.cells.filters.all_filters deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler_filter_classes help: ' Scheduler filter classes. Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. As of the Mitaka release the following filter classes are available: Different cell filter: A scheduler hint of ''different_cell'' with a value of a full cell name may be specified to route a build away from a particular cell. Image properties filter: Image metadata named ''hypervisor_version_requires'' with a version specification may be specified to ensure the build goes to a cell which has hypervisors of the required version. If either the version requirement on the image or the hypervisor capability of the cell is not present, this filter returns without filtering out the cells. Target cell filter: A scheduler hint of ''target_cell'' with a value of a full cell name may be specified to route a build to a particular cell. No error handling is done as there''s no way to know whether the full path is a valid. As an admin user, you can also add a filter that directs builds to a particular cell. ' max: null metavar: null min: null mutable: false name: scheduler_filter_classes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: - nova.cells.weights.all_weighers deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler_weight_classes help: ' Scheduler weight classes. Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. As of the Mitaka release the following weight classes are available: mute_child: Downgrades the likelihood of child cells being chosen for scheduling requests, which haven''t sent capacity or capability updates in a while. Options include mute_weight_multiplier (multiplier for mute children; value should be negative). ram_by_instance_type: Select cells with the most RAM capacity for the instance type being requested. Because higher weights win, Compute returns the number of available units for the instance type requested. The ram_weight_multiplier option defaults to 10.0 that adds to the weight by a factor of 10. Use a negative number to stack VMs on one host instead of spreading out new VMs to more hosts in the cell. weight_offset: Allows modifying the database to weight a particular cell. The highest weight will be the first cell to be scheduled for launching an instance. When the weight_offset of a cell is set to 0, it is unlikely to be picked but it could be picked if other cells have a lower weight, like if they''re full. And when the weight_offset is set to a very high value (for example, ''999999999999999''), it is likely to be picked if another cell do not have a higher weight. ' max: null metavar: null min: null mutable: false name: scheduler_weight_classes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler_retries help: "\nScheduler retries.\n\nHow many retries when no cells are available.\ \ Specifies how many\ntimes the scheduler tries to launch a new instance when\ \ no cells\nare available.\n\nPossible values:\n\n* Positive integer value\n\ \nRelated options:\n\n* This value is used with the ``scheduler_retry_delay``\ \ value\n while retrying to find a suitable cell.\n" max: null metavar: null min: null mutable: false name: scheduler_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler_retry_delay help: "\nScheduler retry delay.\n\nSpecifies the delay (in seconds) between\ \ scheduling retries when no\ncell can be found to place the new instance\ \ on. When the instance\ncould not be scheduled to a cell after ``scheduler_retries``\ \ in\ncombination with ``scheduler_retry_delay``, then the scheduling\nof\ \ the instance failed.\n\nPossible values:\n\n* Time in seconds.\n\nRelated\ \ options:\n\n* This value is used with the ``scheduler_retries`` value\n\ \ while retrying to find a suitable cell.\n" max: null metavar: null min: null mutable: false name: scheduler_retry_delay namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: db_check_interval help: ' 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. ' max: null metavar: null min: null mutable: false name: db_check_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cells_config help: "\nOptional cells configuration.\n\nConfiguration file from which to read\ \ cells configuration. If given,\noverrides reading cells from the database.\n\ \nCells store all inter-cell communication data, including user names\nand\ \ passwords, in the database. Because the cells data is not updated\nvery\ \ frequently, use this option to specify a JSON file to store\ncells data.\ \ With this configuration, the database is no longer\nconsulted when reloading\ \ the cells data. The file must have columns\npresent in the Cell model (excluding\ \ common database fields and the\nid column). You must specify the queue connection\ \ information through\na transport_url field, instead of username, password,\ \ and so on.\n\nThe transport_url has the following form:\nrabbit://USERNAME:PASSWORD@HOSTNAME:PORT/VIRTUAL_HOST\n\ \nPossible values:\n\nThe scheme can be either qpid or rabbit, the following\ \ sample shows\nthis optional configuration:\n\n {\n \"parent\"\ : {\n \"name\": \"parent\",\n \"api_url\": \"http://api.example.com:8774\"\ ,\n \"transport_url\": \"rabbit://rabbit.example.com\",\n \ \ \"weight_offset\": 0.0,\n \"weight_scale\": 1.0,\n \ \ \"is_parent\": true\n },\n \"cell1\": {\n \ \ \"name\": \"cell1\",\n \"api_url\": \"http://api.example.com:8774\"\ ,\n \"transport_url\": \"rabbit://rabbit1.example.com\",\n \ \ \"weight_offset\": 0.0,\n \"weight_scale\": 1.0,\n \ \ \"is_parent\": false\n },\n \"cell2\": {\n \ \ \"name\": \"cell2\",\n \"api_url\": \"http://api.example.com:8774\"\ ,\n \"transport_url\": \"rabbit://rabbit2.example.com\",\n \ \ \"weight_offset\": 0.0,\n \"weight_scale\": 1.0,\n \ \ \"is_parent\": false\n }\n }\n\n" max: null metavar: null min: null mutable: false name: cells_config namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value cinder: help: null opts: - advanced: false choices: null default: volumev2:cinderv2:publicURL deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: catalog_info help: "\nInfo to match when looking for cinder in the service catalog.\n\nPossible\ \ values:\n\n* Format is separated values of the form:\n ::\n\ \nNote: Nova does not support the Cinder v1 API since the Nova 15.0.0 Ocata\n\ release.\n\nRelated options:\n\n* endpoint_template - Setting this option\ \ will override catalog_info\n" max: null metavar: null min: null mutable: false name: catalog_info namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: endpoint_template help: "\nIf this option is set then it will override service catalog lookup\ \ with\nthis template for cinder endpoint\n\nPossible values:\n\n* URL for\ \ cinder endpoint API\n e.g. http://localhost:8776/v2/%(project_id)s\n\n\ Note: Nova does not support the Cinder v1 API since the Nova 15.0.0 Ocata\n\ release.\n\nRelated options:\n\n* catalog_info - If endpoint_template is not\ \ set, catalog_info will be used.\n" max: null metavar: null min: null mutable: false name: endpoint_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: os_region_name help: ' Region name of this node. This is used when picking the URL in the service catalog. Possible values: * Any string representing region name ' max: null metavar: null min: null mutable: false name: os_region_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: http_retries help: ' 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 ' max: null metavar: null min: 0 mutable: false name: http_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cross_az_attach help: ' 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. ' max: null metavar: null min: null mutable: false name: cross_az_attach namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value cloudpipe: help: null opts: - advanced: false choices: null default: '0' deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vpn_image_id deprecated_reason: null deprecated_since: null dest: vpn_image_id help: ' 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 ' max: null metavar: null min: null mutable: false name: vpn_image_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: m1.tiny deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vpn_flavor deprecated_reason: null deprecated_since: null dest: vpn_flavor help: ' Flavor for VPN instances. Possible values: * Any valid flavor name ' max: null metavar: null min: null mutable: false name: vpn_flavor namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $pybasedir/nova/cloudpipe/bootscript.template deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: boot_script_template deprecated_reason: null deprecated_since: null dest: boot_script_template help: ' 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 ' max: null metavar: null min: null mutable: false name: boot_script_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 10.0.0.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: dmz_net deprecated_reason: null deprecated_since: null dest: dmz_net help: "\nNetwork to push into OpenVPN config.\n\nNote: Above mentioned OpenVPN\ \ config can be found at\n/etc/openvpn/server.conf.\n\nPossible values:\n\n\ * Any valid IPv4/IPV6 address\n\nRelated options:\n\n* boot_script_template\ \ - dmz_net is pushed into bootscript.template\n to configure cloudpipe-managed\ \ OpenVPN server\n" max: null metavar: null min: null mutable: false name: dmz_net namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: IP address value - advanced: false choices: null default: 255.255.255.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: dmz_mask deprecated_reason: null deprecated_since: null dest: dmz_mask help: "\nNetmask to push into OpenVPN config.\n\nPossible values:\n\n* Any valid\ \ IPv4/IPV6 netmask\n\nRelated options:\n\n* dmz_net - dmz_net and dmz_mask\ \ is pushed into bootscript.template\n to configure cloudpipe-managed OpenVPN\ \ server\n* boot_script_template\n" max: null metavar: null min: null mutable: false name: dmz_mask namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: IP address value - advanced: false choices: null default: -vpn deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vpn_key_suffix deprecated_reason: null deprecated_since: null dest: vpn_key_suffix help: ' Suffix to add to project name for VPN key and secgroups Possible values: * Any string value representing the VPN key suffix ' max: null metavar: null min: null mutable: false name: vpn_key_suffix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value conductor: help: ' Options under this group are used to define Conductor''s communication, which manager should be act as a proxy between computes and database, and finally, how many worker processes will be used. ' opts: - advanced: false choices: null default: conductor deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There is no need to let users choose the RPC topic for all services - there is little gain from this. Furthermore, it makes it really easy to break Nova by using this option. ' deprecated_since: 15.0.0 dest: topic help: ' Topic exchange name on which conductor nodes listen. ' max: null metavar: null min: null mutable: false name: topic namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: workers help: ' Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. ' max: null metavar: null min: null mutable: false name: workers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value console: help: ' Options under this group allow to tune the configuration of the console proxy service. Note: in configuration of every compute is a ``console_host`` option, which allows to select the console proxy service to connect to. ' opts: - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: default name: console_allowed_origins deprecated_reason: null deprecated_since: null dest: allowed_origins help: ' 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: * A list where each element is an allowed origin hostnames, else an empty list ' max: null metavar: null min: null mutable: false name: allowed_origins namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value consoleauth: help: null opts: - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_token_ttl deprecated_reason: null deprecated_since: null dest: token_ttl help: ' The lifetime of a console auth token. A console auth token is used in authorizing console access for a user. Once the auth token time to live count has elapsed, the token is considered expired. Expired tokens are then deleted. ' max: null metavar: null min: 0 mutable: false name: token_ttl namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value cors: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allowed_origin help: 'Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "://[:]", no trailing slash. Example: https://horizon.example.com' max: null metavar: null min: null mutable: false name: allowed_origin namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_credentials help: Indicate that the actual request can include user credentials max: null metavar: null min: null mutable: false name: allow_credentials namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - X-Auth-Token - X-Openstack-Request-Id - X-Subject-Token - X-Service-Token deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: expose_headers help: Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. max: null metavar: null min: null mutable: false name: expose_headers namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_age help: Maximum cache age of CORS preflight requests. max: null metavar: null min: null mutable: false name: max_age namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: - GET - PUT - POST - DELETE - PATCH deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_methods help: Indicate which methods can be used during the actual request. max: null metavar: null min: null mutable: false name: allow_methods namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: - X-Auth-Token - X-Openstack-Request-Id - X-Identity-Status - X-Roles - X-Service-Catalog - X-User-Id - X-Tenant-Id deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_headers help: Indicate which header field names may be used during the actual request. max: null metavar: null min: null mutable: false name: allow_headers namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value cors.subdomain: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allowed_origin help: 'Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "://[:]", no trailing slash. Example: https://horizon.example.com' max: null metavar: null min: null mutable: false name: allowed_origin namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_credentials help: Indicate that the actual request can include user credentials max: null metavar: null min: null mutable: false name: allow_credentials namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - X-Auth-Token - X-Openstack-Request-Id - X-Subject-Token - X-Service-Token deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: expose_headers help: Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. max: null metavar: null min: null mutable: false name: expose_headers namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_age help: Maximum cache age of CORS preflight requests. max: null metavar: null min: null mutable: false name: max_age namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: - GET - PUT - POST - DELETE - PATCH deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_methods help: Indicate which methods can be used during the actual request. max: null metavar: null min: null mutable: false name: allow_methods namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: - X-Auth-Token - X-Openstack-Request-Id - X-Identity-Status - X-Roles - X-Service-Catalog - X-User-Id - X-Tenant-Id deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allow_headers help: Indicate which header field names may be used during the actual request. max: null metavar: null min: null mutable: false name: allow_headers namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value crypto: help: null opts: - advanced: false choices: null default: cacert.pem deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ca_file deprecated_reason: null deprecated_since: null dest: ca_file help: ' 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 ' max: null metavar: null min: null mutable: false name: ca_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: private/cakey.pem deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: key_file deprecated_reason: null deprecated_since: null dest: key_file help: ' Filename of a private key. Related options: * keys_path ' max: null metavar: null min: null mutable: false name: key_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: crl.pem deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: crl_file deprecated_reason: null deprecated_since: null dest: crl_file help: ' 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 ' max: null metavar: null min: null mutable: false name: crl_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/keys deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: keys_path deprecated_reason: null deprecated_since: null dest: keys_path help: ' Directory path where keys are located. Related options: * key_file ' max: null metavar: null min: null mutable: false name: keys_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/CA deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ca_path deprecated_reason: null deprecated_since: null dest: ca_path help: ' Directory path where root CA is located. Related options: * ca_file ' max: null metavar: null min: null mutable: false name: ca_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_project_ca deprecated_reason: null deprecated_since: null dest: use_project_ca help: Option to enable/disable use of CA for each project. max: null metavar: null min: null mutable: false name: use_project_ca namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: user_cert_subject deprecated_reason: null deprecated_since: null dest: user_cert_subject help: ' Subject for certificate for users, %s for project, user, timestamp ' max: null metavar: null min: null mutable: false name: user_cert_subject namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: project_cert_subject deprecated_reason: null deprecated_since: null dest: project_cert_subject help: ' Subject for certificate for projects, %s for project, timestamp ' max: null metavar: null min: null mutable: false name: project_cert_subject namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value database: help: null opts: - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sqlite_synchronous deprecated_reason: null deprecated_since: null dest: sqlite_synchronous help: If True, SQLite uses synchronous mode. max: null metavar: null min: null mutable: false name: sqlite_synchronous namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: sqlalchemy deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: db_backend deprecated_reason: null deprecated_since: null dest: backend help: The back end to use for the database. max: null metavar: null min: null mutable: false name: backend namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_connection - group: DATABASE name: sql_connection - group: sql name: connection deprecated_reason: null deprecated_since: null dest: connection help: The SQLAlchemy connection string to use to connect to the database. max: null metavar: null min: null mutable: false name: connection namespace: oslo.db positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: slave_connection help: The SQLAlchemy connection string to use to connect to the slave database. max: null metavar: null min: null mutable: false name: slave_connection namespace: oslo.db positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: TRADITIONAL deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mysql_sql_mode help: 'The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=' max: null metavar: null min: null mutable: false name: mysql_sql_mode namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_idle_timeout - group: DATABASE name: sql_idle_timeout - group: sql name: idle_timeout deprecated_reason: null deprecated_since: null dest: idle_timeout help: Timeout before idle SQL connections are reaped. max: null metavar: null min: null mutable: false name: idle_timeout namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_min_pool_size - group: DATABASE name: sql_min_pool_size deprecated_reason: null deprecated_since: null dest: min_pool_size help: Minimum number of SQL connections to keep open in a pool. max: null metavar: null min: null mutable: false name: min_pool_size namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_max_pool_size - group: DATABASE name: sql_max_pool_size deprecated_reason: null deprecated_since: null dest: max_pool_size help: Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. max: null metavar: null min: null mutable: false name: max_pool_size namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_max_retries - group: DATABASE name: sql_max_retries deprecated_reason: null deprecated_since: null dest: max_retries help: Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. max: null metavar: null min: null mutable: false name: max_retries namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_retry_interval - group: DATABASE name: reconnect_interval deprecated_reason: null deprecated_since: null dest: retry_interval help: Interval between retries of opening a SQL connection. max: null metavar: null min: null mutable: false name: retry_interval namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 50 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_max_overflow - group: DATABASE name: sqlalchemy_max_overflow deprecated_reason: null deprecated_since: null dest: max_overflow help: If set, use this value for max_overflow with SQLAlchemy. max: null metavar: null min: null mutable: false name: max_overflow namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_connection_debug deprecated_reason: null deprecated_since: null dest: connection_debug help: 'Verbosity of SQL debugging information: 0=None, 100=Everything.' max: 100 metavar: null min: 0 mutable: false name: connection_debug namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: sql_connection_trace deprecated_reason: null deprecated_since: null dest: connection_trace help: Add Python stack traces to SQL as comment strings. max: null metavar: null min: null mutable: false name: connection_trace namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DATABASE name: sqlalchemy_pool_timeout deprecated_reason: null deprecated_since: null dest: pool_timeout help: If set, use this value for pool_timeout with SQLAlchemy. max: null metavar: null min: null mutable: false name: pool_timeout namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_db_reconnect help: Enable the experimental use of database reconnect on connection lost. max: null metavar: null min: null mutable: false name: use_db_reconnect namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: db_retry_interval help: Seconds between retries of a database transaction. max: null metavar: null min: null mutable: false name: db_retry_interval namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: db_inc_retry_interval help: If True, increases the interval between retries of a database operation up to db_max_retry_interval. max: null metavar: null min: null mutable: false name: db_inc_retry_interval namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: db_max_retry_interval help: If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. max: null metavar: null min: null mutable: false name: db_max_retry_interval namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 20 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: db_max_retries help: Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. max: null metavar: null min: null mutable: false name: db_max_retries namespace: oslo.db positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: dbapi_use_tpool deprecated_reason: null deprecated_since: null dest: use_tpool help: Enable the experimental use of thread pooling for all DB API calls max: null metavar: null min: null mutable: false name: use_tpool namespace: oslo.db.concurrency positional: false required: false sample_default: null secret: false short: null type: boolean value ephemeral_storage_encryption: help: null opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: ' Enables/disables LVM ephemeral storage encryption. ' max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: aes-xts-plain64 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cipher help: ' 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: * Any crypto option listed in ``/proc/crypto``. ' max: null metavar: null min: null mutable: false name: cipher namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 512 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: key_size help: ' 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. ' max: null metavar: null min: 1 mutable: false name: key_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value filter_scheduler: help: null opts: - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_host_subset_size deprecated_reason: null deprecated_since: null dest: host_subset_size help: "\nSize of subset of best hosts selected by scheduler.\n\nNew instances\ \ will be scheduled on a host chosen randomly from a subset of the\nN best\ \ hosts, where N is the value set by this option.\n\nSetting this to a value\ \ greater than 1 will reduce the chance that multiple\nscheduler processes\ \ handling similar requests will select the same host,\ncreating a potential\ \ race condition. By selecting a host randomly from the N\nhosts that best\ \ fit the request, the chance of a conflict is reduced. However,\nthe higher\ \ you set this value, the less optimal the chosen host may be for a\ngiven\ \ request.\n\nThis option is only used by the FilterScheduler and its subclasses;\ \ if you use\na different scheduler, this option has no effect.\n\nPossible\ \ values:\n\n* An integer, where the integer corresponds to the size of a\ \ host subset. Any\n integer is valid, although any value less than 1 will\ \ be treated as 1\n" max: null metavar: null min: 1 mutable: false name: host_subset_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 8 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: max_io_ops_per_host deprecated_reason: null deprecated_since: null dest: max_io_ops_per_host help: "\nThe number of instances that can be actively performing IO on a host.\n\ \nInstances performing IO includes those in the following states: build, resize,\n\ snapshot, migrate, rescue, unshelve.\n\nThis option is only used by the FilterScheduler\ \ and its subclasses; if you use\na different scheduler, this option has no\ \ effect. Also note that this setting\nonly affects scheduling if the 'io_ops_filter'\ \ filter is enabled.\n\nPossible values:\n\n* An integer, where the integer\ \ corresponds to the max number of instances\n that can be actively performing\ \ IO on any given host.\n" max: null metavar: null min: null mutable: false name: max_io_ops_per_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 50 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: max_instances_per_host deprecated_reason: null deprecated_since: null dest: max_instances_per_host help: "\nMaximum number of instances that be active on a host.\n\nIf you need\ \ to limit the number of instances on any given host, set this option\nto\ \ the maximum number of instances you want to allow. The num_instances_filter\n\ will reject any host that has at least as many instances as this option's\n\ value.\n\nThis option is only used by the FilterScheduler and its subclasses;\ \ if you use\na different scheduler, this option has no effect. Also note\ \ that this setting\nonly affects scheduling if the 'num_instances_filter'\ \ filter is enabled.\n\nPossible values:\n\n* An integer, where the integer\ \ corresponds to the max instances that can be\n scheduled on a host.\n" max: null metavar: null min: null mutable: false name: max_instances_per_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_tracks_instance_changes deprecated_reason: null deprecated_since: null dest: track_instance_changes help: ' Enable querying of individual hosts for instance information. The scheduler may need information about the instances on a host in order to evaluate its filters and weighers. The most common need for this information is for the (anti-)affinity filters, which need to choose a host based on the instances already running on a host. If the configured filters and weighers do not need this information, disabling this option will improve performance. It may also be disabled when the tracking overhead proves too heavy, although this will cause classes requiring host usage data to query the database on each request instead. This option is only used by the FilterScheduler and its subclasses; if you use a different scheduler, this option has no effect. ' max: null metavar: null min: null mutable: false name: track_instance_changes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - nova.scheduler.filters.all_filters deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_available_filters deprecated_reason: null deprecated_since: null dest: available_filters help: "\nFilters that the scheduler can use.\n\nAn unordered list of the filter\ \ classes the nova scheduler may apply. Only the\nfilters specified in the\ \ 'scheduler_enabled_filters' option will be used, but\nany filter appearing\ \ in that option must also be included in this list.\n\nBy default, this is\ \ set to all filters that are included with nova.\n\nThis option is only used\ \ by the FilterScheduler and its subclasses; if you use\na different scheduler,\ \ this option has no effect.\n\nPossible values:\n\n* A list of zero or more\ \ strings, where each string corresponds to the name of\n a filter that may\ \ be used for selecting a host\n\nRelated options:\n\n* scheduler_enabled_filters\n" max: null metavar: null min: null mutable: false name: available_filters namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: - RetryFilter - AvailabilityZoneFilter - RamFilter - DiskFilter - ComputeFilter - ComputeCapabilitiesFilter - ImagePropertiesFilter - ServerGroupAntiAffinityFilter - ServerGroupAffinityFilter deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_default_filters deprecated_reason: null deprecated_since: null dest: enabled_filters help: "\nFilters that the scheduler will use.\n\nAn ordered list of filter class\ \ names that will be used for filtering\nhosts. Ignore the word 'default'\ \ in the name of this option: these filters will\n*always* be applied, and\ \ they will be applied in the order they are listed so\nplace your most restrictive\ \ filters first to make the filtering process more\nefficient.\n\nThis option\ \ is only used by the FilterScheduler and its subclasses; if you use\na different\ \ scheduler, this option has no effect.\n\nPossible values:\n\n* A list of\ \ zero or more strings, where each string corresponds to the name of\n a\ \ filter to be used for selecting a host\n\nRelated options:\n\n* All of the\ \ filters in this option *must* be present in the\n 'scheduler_available_filters'\ \ option, or a SchedulerHostFilterNotFound\n exception will be raised.\n" max: null metavar: null min: null mutable: false name: enabled_filters namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: - RetryFilter - AvailabilityZoneFilter - ComputeFilter - ComputeCapabilitiesFilter - ImagePropertiesFilter - ExactRamFilter - ExactDiskFilter - ExactCoreFilter deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: baremetal_scheduler_default_filters deprecated_reason: null deprecated_since: null dest: baremetal_enabled_filters help: "\nFilters used for filtering baremetal hosts.\n\nFilters are applied\ \ in order, so place your most restrictive filters first to\nmake the filtering\ \ process more efficient.\n\nThis option is only used by the FilterScheduler\ \ and its subclasses; if you use\na different scheduler, this option has no\ \ effect.\n\nPossible values:\n\n* A list of zero or more strings, where each\ \ string corresponds to the name of\n a filter to be used for selecting a\ \ baremetal host\n\nRelated options:\n\n* If the 'scheduler_use_baremetal_filters'\ \ option is False, this option has\n no effect.\n" max: null metavar: null min: null mutable: false name: baremetal_enabled_filters namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_use_baremetal_filters deprecated_reason: null deprecated_since: null dest: use_baremetal_filters help: "\nEnable baremetal filters.\n\nSet this to True to tell the nova scheduler\ \ that it should use the filters\nspecified in the 'baremetal_scheduler_enabled_filters'\ \ option. If you are not\nscheduling baremetal nodes, leave this at the default\ \ setting of False.\n\nThis option is only used by the FilterScheduler and\ \ its subclasses; if you use\na different scheduler, this option has no effect.\n\ \nRelated options:\n\n* If this option is set to True, then the filters specified\ \ in the\n 'baremetal_scheduler_enabled_filters' are used instead of the\ \ filters\n specified in 'scheduler_enabled_filters'.\n" max: null metavar: null min: null mutable: false name: use_baremetal_filters namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - nova.scheduler.weights.all_weighers deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_weight_classes deprecated_reason: null deprecated_since: null dest: weight_classes help: "\nWeighers that the scheduler will use.\n\nOnly hosts which pass the\ \ filters are weighed. The weight for any host starts\nat 0, and the weighers\ \ order these hosts by adding to or subtracting from the\nweight assigned\ \ by the previous weigher. Weights may become negative. An\ninstance will\ \ be scheduled to one of the N most-weighted hosts, where N is\n'scheduler_host_subset_size'.\n\ \nBy default, this is set to all weighers that are included with Nova.\n\n\ This option is only used by the FilterScheduler and its subclasses; if you\ \ use\na different scheduler, this option has no effect.\n\nPossible values:\n\ \n* A list of zero or more strings, where each string corresponds to the name\ \ of\n a weigher that will be used for selecting a host\n" max: null metavar: null min: null mutable: false name: weight_classes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ram_weight_multiplier deprecated_reason: null deprecated_since: null dest: ram_weight_multiplier help: "\nRam weight multipler ratio.\n\nThis option determines how hosts with\ \ more or less available RAM are weighed. A\npositive value will result in\ \ the scheduler preferring hosts with more\navailable RAM, and a negative\ \ number will result in the scheduler preferring\nhosts with less available\ \ RAM. Another way to look at it is that positive\nvalues for this option\ \ will tend to spread instances across many hosts, while\nnegative values\ \ will tend to fill up (stack) hosts as much as possible before\nscheduling\ \ to a less-used host. The absolute value, whether positive or\nnegative,\ \ controls how strong the RAM weigher is relative to other weighers.\n\nThis\ \ option is only used by the FilterScheduler and its subclasses; if you use\n\ a different scheduler, this option has no effect. Also note that this setting\n\ only affects scheduling if the 'ram' weigher is enabled.\n\nPossible values:\n\ \n* An integer or float value, where the value corresponds to the multipler\n\ \ ratio for this weigher.\n" max: null metavar: null min: null mutable: false name: ram_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: disk_weight_multiplier deprecated_reason: null deprecated_since: null dest: disk_weight_multiplier help: "\nDisk weight multipler ratio.\n\nMultiplier used for weighing free disk\ \ space. Negative numbers mean to\nstack vs spread.\n\nThis option is only\ \ used by the FilterScheduler and its subclasses; if you use\na different\ \ scheduler, this option has no effect. Also note that this setting\nonly\ \ affects scheduling if the 'ram' weigher is enabled.\n\nPossible values:\n\ \n* An integer or float value, where the value corresponds to the multipler\n\ \ ratio for this weigher.\n" max: null metavar: null min: null mutable: false name: disk_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: -1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: io_ops_weight_multiplier deprecated_reason: null deprecated_since: null dest: io_ops_weight_multiplier help: "\nIO operations weight multipler ratio.\n\nThis option determines how\ \ hosts with differing workloads are weighed. Negative\nvalues, such as the\ \ default, will result in the scheduler preferring hosts with\nlighter workloads\ \ whereas positive values will prefer hosts with heavier\nworkloads. Another\ \ way to look at it is that positive values for this option\nwill tend to\ \ schedule instances onto hosts that are already busy, while\nnegative values\ \ will tend to distribute the workload across more hosts. The\nabsolute value,\ \ whether positive or negative, controls how strong the io_ops\nweigher is\ \ relative to other weighers.\n\nThis option is only used by the FilterScheduler\ \ and its subclasses; if you use\na different scheduler, this option has no\ \ effect. Also note that this setting\nonly affects scheduling if the 'io_ops'\ \ weigher is enabled.\n\nPossible values:\n\n* An integer or float value,\ \ where the value corresponds to the multipler\n ratio for this weigher.\n" max: null metavar: null min: null mutable: false name: io_ops_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: soft_affinity_weight_multiplier deprecated_reason: null deprecated_since: null dest: soft_affinity_weight_multiplier help: "\nMultiplier used for weighing hosts for group soft-affinity.\n\nPossible\ \ values:\n\n* An integer or float value, where the value corresponds to weight\ \ multiplier\n for hosts with group soft affinity. Only a positive value\ \ are meaningful, as\n negative values would make this behave as a soft anti-affinity\ \ weigher.\n" max: null metavar: null min: null mutable: false name: soft_affinity_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: soft_anti_affinity_weight_multiplier deprecated_reason: null deprecated_since: null dest: soft_anti_affinity_weight_multiplier help: "\nMultiplier used for weighing hosts for group soft-anti-affinity.\n\n\ Possible values:\n\n* An integer or float value, where the value corresponds\ \ to weight multiplier\n for hosts with group soft anti-affinity. Only a\ \ positive value are\n meaningful, as negative values would make this behave\ \ as a soft affinity\n weigher.\n" max: null metavar: null min: null mutable: false name: soft_anti_affinity_weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: isolated_images deprecated_reason: null deprecated_since: null dest: isolated_images help: "\nList of UUIDs for images that can only be run on certain hosts.\n\n\ If there is a need to restrict some images to only run on certain designated\n\ hosts, list those image UUIDs here.\n\nThis option is only used by the FilterScheduler\ \ and its subclasses; if you use\na different scheduler, this option has no\ \ effect. Also note that this setting\nonly affects scheduling if the 'IsolatedHostsFilter'\ \ filter is enabled.\n\nPossible values:\n\n* A list of UUID strings, where\ \ each string corresponds to the UUID of an\n image\n\nRelated options:\n\ \n* scheduler/isolated_hosts\n* scheduler/restrict_isolated_hosts_to_isolated_images\n" max: null metavar: null min: null mutable: false name: isolated_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: isolated_hosts deprecated_reason: null deprecated_since: null dest: isolated_hosts help: ' List of hosts that can only run certain images. If there is a need to restrict some images to only run on certain designated hosts, list those host names here. 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 ''IsolatedHostsFilter'' filter is enabled. Possible values: * A list of strings, where each string corresponds to the name of a host Related options: * scheduler/isolated_images * scheduler/restrict_isolated_hosts_to_isolated_images ' max: null metavar: null min: null mutable: false name: isolated_hosts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: restrict_isolated_hosts_to_isolated_images deprecated_reason: null deprecated_since: null dest: restrict_isolated_hosts_to_isolated_images help: ' Prevent non-isolated images from being built on isolated hosts. 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 ''IsolatedHostsFilter'' filter is enabled. Even then, this option doesn''t affect the behavior of requests for isolated images, which will *always* be restricted to isolated hosts. Related options: * scheduler/isolated_images * scheduler/isolated_hosts ' max: null metavar: null min: null mutable: false name: restrict_isolated_hosts_to_isolated_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: aggregate_image_properties_isolation_namespace deprecated_reason: null deprecated_since: null dest: aggregate_image_properties_isolation_namespace help: ' Image property namespace for use in the host aggregate. Images and hosts can be configured so that certain images can only be scheduled to hosts in a particular aggregate. This is done with metadata values set on the host aggregate that are identified by beginning with the value of this option. If the host is part of an aggregate with such a metadata key, the image in the request spec must have the value of that metadata in its properties in order for the scheduler to consider the host as acceptable. 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 ''aggregate_image_properties_isolation'' filter is enabled. Possible values: * A string, where the string corresponds to an image property namespace Related options: * aggregate_image_properties_isolation_separator ' max: null metavar: null min: null mutable: false name: aggregate_image_properties_isolation_namespace namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: . deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: aggregate_image_properties_isolation_separator deprecated_reason: null deprecated_since: null dest: aggregate_image_properties_isolation_separator help: "\nSeparator character(s) for image property namespace and name.\n\nWhen\ \ using the aggregate_image_properties_isolation filter, the relevant\nmetadata\ \ keys are prefixed with the namespace defined in the\naggregate_image_properties_isolation_namespace\ \ configuration option plus a\nseparator. This option defines the separator\ \ to be used.\n\nThis option is only used by the FilterScheduler and its subclasses;\ \ if you use\na different scheduler, this option has no effect. Also note\ \ that this setting\nonly affects scheduling if the 'aggregate_image_properties_isolation'\ \ filter\nis enabled.\n\nPossible values:\n\n* A string, where the string\ \ corresponds to an image property namespace\n separator character\n\nRelated\ \ options:\n\n* aggregate_image_properties_isolation_namespace\n" max: null metavar: null min: null mutable: false name: aggregate_image_properties_isolation_separator namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value glance: help: Configuration options for the Image service opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_servers help: "\nList of glance api servers endpoints available to nova.\n\nhttps is\ \ used for ssl-based glance api servers.\n\nPossible values:\n\n* A list of\ \ any fully qualified url of the form \"scheme://hostname:port[/path]\"\n\ \ (i.e. \"http://10.0.1.0:9292\" or \"https://my.glance.server/image\").\n" max: null metavar: null min: null mutable: false name: api_servers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_insecure help: ' Enable insecure SSL (https) requests to glance. This setting can be used to turn off verification of the glance server certificate against the certificate authorities. ' max: null metavar: null min: null mutable: false name: api_insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: num_retries help: ' Enable glance operation retries. Specifies the number of retries when uploading / downloading an image to / from glance. 0 means no retries. ' max: null metavar: null min: 0 mutable: false name: num_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: allowed_direct_url_schemes help: ' List of url schemes that can be directly accessed. This option specifies a list of url schemes that can be downloaded directly via the direct_url. This direct_URL can be fetched from Image metadata which can be used by nova to get the image more efficiently. nova-compute could benefit from this by invoking a copy when it has access to the same file system as glance. Possible values: * [file], Empty list (default) ' max: null metavar: null min: null mutable: false name: allowed_direct_url_schemes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: verify_glance_signatures help: "\nEnable image signature verification.\n\nnova uses the image signature\ \ metadata from glance and verifies the signature\nof a signed image while\ \ downloading that image. If the image signature cannot\nbe verified or if\ \ the image signature metadata is either incomplete or\nunavailable, then\ \ nova will not boot the image and instead will place the\ninstance into an\ \ error state. This provides end users with stronger assurances\nof the integrity\ \ of the image data they are using to create servers.\n\nRelated options:\n\ \n* The options in the `key_manager` group, as the key_manager is used\n \ \ for the signature validation.\n" max: null metavar: null min: null mutable: false name: verify_glance_signatures namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: debug help: Enable or disable debug logging with glanceclient. max: null metavar: null min: null mutable: false name: debug namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value guestfs: help: ' libguestfs is a set of tools for accessing and modifying virtual machine (VM) disk images. You can use this for viewing and editing files inside guests, scripting changes to VMs, monitoring disk used/free statistics, creating guests, P2V, V2V, performing backups, cloning VMs, building VMs, formatting disks and resizing disks. ' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: debug help: "\nEnable/disables guestfs logging.\n\nThis configures guestfs to debug\ \ messages and push them to Openstack\nlogging system. When set to True, it\ \ traces libguestfs API calls and\nenable verbose debug messages. In order\ \ to use the above feature,\n\"libguestfs\" package must be installed.\n\n\ Related options:\nSince libguestfs access and modifies VM's managed by libvirt,\ \ below options\nshould be set to give access to those VM's.\n * libvirt.inject_key\n\ \ * libvirt.inject_partition\n * libvirt.inject_password\n" max: null metavar: null min: null mutable: false name: debug namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value healthcheck: help: null opts: - advanced: false choices: null default: /healthcheck deprecated_for_removal: true deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: path help: The path to respond to healtcheck requests on. max: null metavar: null min: null mutable: false name: path namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: detailed help: Show more detailed information as part of the response max: null metavar: null min: null mutable: false name: detailed namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: backends help: Additional backends that can perform health checks and report that information back as part of a request. max: null metavar: null min: null mutable: false name: backends namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disable_by_file_path help: Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin. max: null metavar: null min: null mutable: false name: disable_by_file_path namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disable_by_file_paths help: Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. max: null metavar: null min: null mutable: false name: disable_by_file_paths namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: list value hyperv: help: ' The hyperv feature allows you to configure the Hyper-V hypervisor driver to be used within an OpenStack deployment. ' opts: - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: dynamic_memory_ratio help: "\nDynamic memory ratio\n\nEnables dynamic memory allocation (ballooning)\ \ when set to a value\ngreater than 1. The value expresses the ratio between\ \ the total RAM\nassigned to an instance and its startup RAM amount. For example\ \ a\nratio of 2.0 for an instance with 1024MB of RAM implies 512MB of\nRAM\ \ allocated at startup.\n\nPossible values:\n\n* 1.0: Disables dynamic memory\ \ allocation (Default).\n* Float values greater than 1.0: Enables allocation\ \ of total implied\n RAM divided by this value for startup.\n" max: null metavar: null min: null mutable: false name: dynamic_memory_ratio namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enable_instance_metrics_collection help: ' Enable instance metrics collection Enables metrics collections for an instance by using Hyper-V''s metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. ' max: null metavar: null min: null mutable: false name: enable_instance_metrics_collection namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: instances_path_share help: "\nInstances path share\n\nThe name of a Windows share mapped to the \"\ instances_path\" dir\nand used by the resize feature to copy files to the\ \ target host.\nIf left blank, an administrative share (hidden network share)\ \ will\nbe used, looking for the same \"instances_path\" used locally.\n\n\ Possible values:\n\n* \"\": An administrative share will be used (Default).\n\ * Name of a Windows share.\n\nRelated options:\n\n* \"instances_path\": The\ \ directory which will be used if this option\n here is left blank.\n" max: null metavar: null min: null mutable: false name: instances_path_share namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: limit_cpu_features help: ' 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. ' max: null metavar: null min: null mutable: false name: limit_cpu_features namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mounted_disk_query_retry_count help: "\nMounted disk query retry count\n\nThe number of times to retry checking\ \ for a mounted disk.\nThe query runs until the device can be found or the\ \ retry\ncount is reached.\n\nPossible values:\n\n* Positive integer values.\ \ Values greater than 1 is recommended\n (Default: 10).\n\nRelated options:\n\ \n* Time interval between disk mount retries is declared with\n \"mounted_disk_query_retry_interval\"\ \ option.\n" max: null metavar: null min: 0 mutable: false name: mounted_disk_query_retry_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mounted_disk_query_retry_interval help: "\nMounted disk query retry interval\n\nInterval between checks for a\ \ mounted disk, in seconds.\n\nPossible values:\n\n* Time in seconds (Default:\ \ 5).\n\nRelated options:\n\n* This option is meaningful when the mounted_disk_query_retry_count\n\ \ is greater than 1.\n* The retry loop runs with mounted_disk_query_retry_count\ \ and\n mounted_disk_query_retry_interval configuration options.\n" max: null metavar: null min: 0 mutable: false name: mounted_disk_query_retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: power_state_check_timeframe help: ' Power state check timeframe The timeframe to be checked for instance power state changes. This option is used to fetch the state of the instance from Hyper-V through the WMI interface, within the specified timeframe. Possible values: * Timeframe in seconds (Default: 60). ' max: null metavar: null min: 0 mutable: false name: power_state_check_timeframe namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: power_state_event_polling_interval help: ' 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). ' max: null metavar: null min: 0 mutable: false name: power_state_event_polling_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: qemu-img.exe deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: qemu_img_cmd help: "\nqemu-img command\n\nqemu-img is required for some of the image related\ \ operations\nlike converting between different image types. You can get it\n\ from here: (http://qemu.weilnetz.de/) or you can install the\nCloudbase OpenStack\ \ Hyper-V Compute Driver\n(https://cloudbase.it/openstack-hyperv-driver/)\ \ which automatically\nsets the proper path for this config option. You can\ \ either give the\nfull path of qemu-img.exe or set its path in the PATH environment\n\ variable and leave this option to the default value.\n\nPossible values:\n\ \n* Name of the qemu-img executable, in case it is in the same\n directory\ \ as the nova-compute service or its path is in the\n PATH environment variable\ \ (Default).\n* Path of qemu-img command (DRIVELETTER:\\PATH\\TO\\QEMU-IMG\\\ COMMAND).\n\nRelated options:\n\n* If the config_drive_cdrom option is False,\ \ qemu-img will be used to\n convert the ISO to a VHD, otherwise the configuration\ \ drive will\n remain an ISO. To use configuration drive with Hyper-V, you\ \ must\n set the mkisofs_cmd value to the full path to an mkisofs.exe\n \ \ installation.\n" max: null metavar: null min: null mutable: false name: qemu_img_cmd namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vswitch_name help: "\nExternal virtual switch name\n\nThe Hyper-V Virtual Switch is a software-based\ \ layer-2 Ethernet\nnetwork switch that is available with the installation\ \ of the\nHyper-V server role. The switch includes programmatically managed\n\ and extensible capabilities to connect virtual machines to both\nvirtual networks\ \ and the physical network. In addition, Hyper-V\nVirtual Switch provides\ \ policy enforcement for security, isolation,\nand service levels. The vSwitch\ \ represented by this config option\nmust be an external one (not internal\ \ or private).\n\nPossible values:\n\n* If not provided, the first of a list\ \ of available vswitches\n is used. This list is queried using WQL.\n* Virtual\ \ switch name.\n" max: null metavar: null min: null mutable: false name: vswitch_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: wait_soft_reboot_seconds help: ' Wait soft reboot seconds Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. Possible values: * Time in seconds (Default: 60). ' max: null metavar: null min: 0 mutable: false name: wait_soft_reboot_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: config_drive_cdrom help: "\nConfiguration drive cdrom\n\nOpenStack can be configured to write instance\ \ metadata to\na configuration drive, which is then attached to the\ninstance\ \ before it boots. The configuration drive can be\nattached as a disk drive\ \ (default) or as a CD drive.\n\nPossible values:\n\n* True: Attach the configuration\ \ drive image as a CD drive.\n* False: Attach the configuration drive image\ \ as a disk drive (Default).\n\nRelated options:\n\n* This option is meaningful\ \ with force_config_drive option set to 'True'\n or when the REST API call\ \ to create an instance will have\n '--config-drive=True' flag.\n* config_drive_format\ \ option must be set to 'iso9660' in order to use\n CD drive as the configuration\ \ drive image.\n* To use configuration drive with Hyper-V, you must set the\n\ \ mkisofs_cmd value to the full path to an mkisofs.exe installation.\n Additionally,\ \ you must set the qemu_img_cmd value to the full path\n to an qemu-img command\ \ installation.\n* You can configure the Compute service to always create\ \ a configuration\n drive by setting the force_config_drive option to 'True'.\n" max: null metavar: null min: null mutable: false name: config_drive_cdrom namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: config_drive_inject_password help: "\nConfiguration drive inject password\n\nEnables setting the admin password\ \ in the configuration drive image.\n\nRelated options:\n\n* This option is\ \ meaningful when used with other options that enable\n configuration drive\ \ usage with Hyper-V, such as force_config_drive.\n* Currently, the only accepted\ \ config_drive_format is 'iso9660'.\n" max: null metavar: null min: null mutable: false name: config_drive_inject_password namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: volume_attach_retry_count help: "\nVolume attach retry count\n\nThe number of times to retry attaching\ \ a volume. Volume attachment\nis retried until success or the given retry\ \ count is reached.\n\nPossible values:\n\n* Positive integer values (Default:\ \ 10).\n\nRelated options:\n\n* Time interval between attachment attempts\ \ is declared with\n volume_attach_retry_interval option.\n" max: null metavar: null min: 0 mutable: false name: volume_attach_retry_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: volume_attach_retry_interval help: "\nVolume attach retry interval\n\nInterval between volume attachment\ \ attempts, in seconds.\n\nPossible values:\n\n* Time in seconds (Default:\ \ 5).\n\nRelated options:\n\n* This options is meaningful when volume_attach_retry_count\n\ \ is greater than 1.\n* The retry loop runs with volume_attach_retry_count\ \ and\n volume_attach_retry_interval configuration options.\n" max: null metavar: null min: 0 mutable: false name: volume_attach_retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enable_remotefx help: "\nEnable RemoteFX feature\n\nThis requires at least one DirectX 11 capable\ \ graphics adapter for\nWindows / Hyper-V Server 2012 R2 or newer and RDS-Virtualization\n\ feature has to be enabled.\n\nInstances with RemoteFX can be requested with\ \ the following flavor\nextra specs:\n\n**os:resolution**. Guest VM screen\ \ resolution size. Acceptable values::\n\n 1024x768, 1280x1024, 1600x1200,\ \ 1920x1200, 2560x1600, 3840x2160\n\n``3840x2160`` is only available on Windows\ \ / Hyper-V Server 2016.\n\n**os:monitors**. Guest VM number of monitors.\ \ Acceptable values::\n\n [1, 4] - Windows / Hyper-V Server 2012 R2\n \ \ [1, 8] - Windows / Hyper-V Server 2016\n\n**os:vram**. Guest VM VRAM amount.\ \ Only available on\nWindows / Hyper-V Server 2016. Acceptable values::\n\n\ \ 64, 128, 256, 512, 1024\n" max: null metavar: null min: null mutable: false name: enable_remotefx namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_multipath_io help: ' Use multipath connections when attaching iSCSI or FC disks. This requires the Multipath IO Windows feature to be enabled. MPIO must be configured to claim such devices. ' max: null metavar: null min: null mutable: false name: use_multipath_io namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: iscsi_initiator_list help: ' List of iSCSI initiators that will be used for estabilishing iSCSI sessions. If none are specified, the Microsoft iSCSI initiator service will choose the initiator. ' max: null metavar: null min: null mutable: false name: iscsi_initiator_list namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value ironic: help: ' Configuration options for Ironic driver (Bare Metal). If using the Ironic driver following options must be set: * auth_type * auth_url * project_name * username * password * project_domain_id or project_domain_name * user_domain_id or user_domain_name ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_endpoint help: URL override for the Ironic API endpoint. max: null metavar: null min: null mutable: false name: api_endpoint namespace: nova.conf positional: false required: false sample_default: http://ironic.example.org:6385/ secret: false short: null type: string value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_max_retries help: ' The number of times to retry when a request conflicts. If set to 0, only try once, no retries. Related options: * api_retry_interval ' max: null metavar: null min: 0 mutable: false name: api_max_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_retry_interval help: ' The number of seconds to wait before retrying the request. Related options: * api_max_retries ' max: null metavar: null min: 0 mutable: false name: api_retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: serial_console_state_timeout help: Timeout (seconds) to wait for node serial console state changed. Set to 0 to disable timeout. max: null metavar: null min: 0 mutable: false name: serial_console_state_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: PEM encoded Certificate Authority to use when verifying HTTPs connections. max: null metavar: null min: null mutable: false name: cafile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: PEM encoded client certificate cert file max: null metavar: null min: null mutable: false name: certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: PEM encoded client certificate key file max: null metavar: null min: null mutable: false name: keyfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout help: Timeout value for http requests max: null metavar: null min: null mutable: false name: timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: ironic name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_url help: Authentication URL max: null metavar: null min: null mutable: false name: auth-url namespace: nova.conf positional: false required: true sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID to scope to max: null metavar: null min: null mutable: false name: domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name to scope to max: null metavar: null min: null mutable: false name: domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID to scope to max: null metavar: null min: null mutable: false name: project-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name to scope to max: null metavar: null min: null mutable: false name: project-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Domain ID containing project max: null metavar: null min: null mutable: false name: project-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Domain name containing project max: null metavar: null min: null mutable: false name: project-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID max: null metavar: null min: null mutable: false name: trust-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID max: null metavar: null min: null mutable: false name: user-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: ironic name: user_name deprecated_reason: null deprecated_since: null dest: username help: Username max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain id max: null metavar: null min: null mutable: false name: user-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name max: null metavar: null min: null mutable: false name: user-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: User's password max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value key_manager: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: keymgr name: fixed_key deprecated_reason: null deprecated_since: null dest: fixed_key help: ' Fixed key returned by key manager, specified in hex. Possible values: * Empty string or a key in hex value ' max: null metavar: null min: null mutable: false name: fixed_key namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: castellan.key_manager.barbican_key_manager.BarbicanKeyManager deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_class help: The full class name of the key manager API class max: null metavar: null min: null mutable: false name: api_class namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_type help: The type of authentication credential to create. Possible values are 'token', 'password', 'keystone_token', and 'keystone_password'. Required if no context is passed to the credential factory. max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: token help: Token for authentication. Required for 'token' and 'keystone_token' auth_type if no context is passed to the credential factory. max: null metavar: null min: null mutable: false name: token namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: username help: Username for authentication. Required for 'password' auth_type. Optional for the 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: Password for authentication. Required for 'password' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID for authentication. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: user_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain ID for authentication. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: user_domain_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name for authentication. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: user_domain_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID for trust scoping. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: trust_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID for domain scoping. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: domain_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name for domain scoping. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: domain_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID for project scoping. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: project_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name for project scoping. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: project_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Project's domain ID for project. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: project_domain_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Project's domain name for project. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: project_domain_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reauthenticate help: Allow fetching a new token if the current one is going to expire. Optional for 'keystone_token' and 'keystone_password' auth_type. max: null metavar: null min: null mutable: false name: reauthenticate namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value keystone_authtoken: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_uri help: Complete "public" Identity API endpoint. This endpoint should not be an "admin" endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you're using a versioned v2 endpoint here, then this should *not* be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. max: null metavar: null min: null mutable: false name: auth_uri namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_version help: API version of the admin Identity API endpoint. max: null metavar: null min: null mutable: false name: auth_version namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: delay_auth_decision help: Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. max: null metavar: null min: null mutable: false name: delay_auth_decision namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: http_connect_timeout help: Request timeout value for communicating with Identity API server. max: null metavar: null min: null mutable: false name: http_connect_timeout namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: http_request_max_retries help: How many times are we trying to reconnect when communicating with Identity API Server. max: null metavar: null min: null mutable: false name: http_request_max_retries namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cache help: Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the ``memcached_servers`` option instead. max: null metavar: null min: null mutable: false name: cache namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: Required if identity server requires client certificate max: null metavar: null min: null mutable: false name: certfile namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: Required if identity server requires client certificate max: null metavar: null min: null mutable: false name: keyfile namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. max: null metavar: null min: null mutable: false name: cafile namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: region_name help: The region in which the identity server can be found. max: null metavar: null min: null mutable: false name: region_name namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: PKI token format is no longer supported. deprecated_since: Ocata dest: signing_dir help: Directory used to cache files related to PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release. max: null metavar: null min: null mutable: false name: signing_dir namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: keystone_authtoken name: memcache_servers deprecated_reason: null deprecated_since: null dest: memcached_servers help: Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. max: null metavar: null min: null mutable: false name: memcached_servers namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: token_cache_time help: In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. max: null metavar: null min: null mutable: false name: token_cache_time namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: PKI token format is no longer supported. deprecated_since: Ocata dest: revocation_cache_time help: Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. Only valid for PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release. max: null metavar: null min: null mutable: false name: revocation_cache_time namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - None - MAC - ENCRYPT default: None deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_security_strategy help: (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. max: null metavar: null min: null mutable: false name: memcache_security_strategy namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_secret_key help: (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. max: null metavar: null min: null mutable: false name: memcache_secret_key namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_dead_retry help: (Optional) Number of seconds memcached server is considered dead before it is tried again. max: null metavar: null min: null mutable: false name: memcache_pool_dead_retry namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_maxsize help: (Optional) Maximum total number of open connections to every memcached server. max: null metavar: null min: null mutable: false name: memcache_pool_maxsize namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_socket_timeout help: (Optional) Socket timeout in seconds for communicating with a memcached server. max: null metavar: null min: null mutable: false name: memcache_pool_socket_timeout namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_unused_timeout help: (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. max: null metavar: null min: null mutable: false name: memcache_pool_unused_timeout namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_pool_conn_get_timeout help: (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. max: null metavar: null min: null mutable: false name: memcache_pool_conn_get_timeout namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: memcache_use_advanced_pool help: (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. max: null metavar: null min: null mutable: false name: memcache_use_advanced_pool namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: include_service_catalog help: (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. max: null metavar: null min: null mutable: false name: include_service_catalog namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: permissive deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enforce_token_bind help: 'Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.' max: null metavar: null min: null mutable: false name: enforce_token_bind namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: PKI token format is no longer supported. deprecated_since: Ocata dest: check_revocations_for_cached help: If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. max: null metavar: null min: null mutable: false name: check_revocations_for_cached namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: - md5 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: PKI token format is no longer supported. deprecated_since: Ocata dest: hash_algorithms help: Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. max: null metavar: null min: null mutable: false name: hash_algorithms namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: - service deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: service_token_roles help: A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check. max: null metavar: null min: null mutable: false name: service_token_roles namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: service_token_roles_required help: For backwards compatibility reasons we must let valid service tokens pass that don't pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible. max: null metavar: null min: null mutable: false name: service_token_roles_required namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: keystone_authtoken name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: keystonemiddleware.auth_token positional: false required: false sample_default: null secret: false short: null type: string value libvirt: help: ' Libvirt options allows cloud administrator to configure related libvirt hypervisor driver to be used within an OpenStack deployment. Almost all of the libvirt config options are influence by ``virt_type`` config which describes the virtualization type (or so called domain type) libvirt should use for specific features such as live migration, snapshot. ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rescue_image_id help: "\nThe ID of the image to boot from to rescue data from a corrupted instance.\n\ \nIf the rescue REST API operation doesn't provide an ID of an image to\n\ use, the image which is referenced by this ID is used. If this\noption is\ \ not set, the image from the instance is used.\n\nPossible values:\n\n* An\ \ ID of an image or nothing. If it points to an *Amazon Machine\n Image*\ \ (AMI), consider to set the config options ``rescue_kernel_id``\n and ``rescue_ramdisk_id``\ \ too. If nothing is set, the image of the instance\n is used.\n\nRelated\ \ options:\n\n* ``rescue_kernel_id``: If the chosen rescue image allows the\ \ separate\n definition of its kernel disk, the value of this option is used,\n\ \ if specified. This is the case when *Amazon*'s AMI/AKI/ARI image\n format\ \ is used for the rescue image.\n* ``rescue_ramdisk_id``: If the chosen rescue\ \ image allows the separate\n definition of its RAM disk, the value of this\ \ option is used if,\n specified. This is the case when *Amazon*'s AMI/AKI/ARI\ \ image\n format is used for the rescue image.\n" max: null metavar: null min: null mutable: false name: rescue_image_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rescue_kernel_id help: "\nThe ID of the kernel (AKI) image to use with the rescue image.\n\n\ If the chosen rescue image allows the separate definition of its kernel\n\ disk, the value of this option is used, if specified. This is the case\nwhen\ \ *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.\n\nPossible\ \ values:\n\n* An ID of an kernel image or nothing. If nothing is specified,\ \ the kernel\n disk from the instance is used if it was launched with one.\n\ \nRelated options:\n\n* ``rescue_image_id``: If that option points to an image\ \ in *Amazon*'s\n AMI/AKI/ARI image format, it's useful to use ``rescue_kernel_id``\ \ too.\n" max: null metavar: null min: null mutable: false name: rescue_kernel_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rescue_ramdisk_id help: "\nThe ID of the RAM disk (ARI) image to use with the rescue image.\n\n\ If the chosen rescue image allows the separate definition of its RAM\ndisk,\ \ the value of this option is used, if specified. This is the case\nwhen *Amazon*'s\ \ AMI/AKI/ARI image format is used for the rescue image.\n\nPossible values:\n\ \n* An ID of a RAM disk image or nothing. If nothing is specified, the RAM\n\ \ disk from the instance is used if it was launched with one.\n\nRelated\ \ options:\n\n* ``rescue_image_id``: If that option points to an image in\ \ *Amazon*'s\n AMI/AKI/ARI image format, it's useful to use ``rescue_ramdisk_id``\ \ too.\n" max: null metavar: null min: null mutable: false name: rescue_ramdisk_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - kvm - lxc - qemu - uml - xen - parallels default: kvm deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: virt_type help: ' Describes the virtualization type (or so called domain type) libvirt should use. The choice of this type must match the underlying virtualization strategy you have chosen for this host. Possible values: * See the predefined set of case-sensitive values. Related options: * ``connection_uri``: depends on this * ``disk_prefix``: depends on this * ``cpu_mode``: depends on this * ``cpu_model``: depends on this ' max: null metavar: null min: null mutable: false name: virt_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_uri help: "\nOverrides the default libvirt URI of the chosen virtualization type.\n\ \nIf set, Nova will use this URI to connect to libvirt.\n\nPossible values:\n\ \n* An URI like ``qemu:///system`` or ``xen+ssh://oirase/`` for example.\n\ \ This is only necessary if the URI differs to the commonly known URIs\n\ \ for the chosen virtualization type.\n\nRelated options:\n\n* ``virt_type``:\ \ Influences what is used as default value here.\n" max: null metavar: null min: null mutable: false name: connection_uri namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: inject_password help: "\nAllow the injection of an admin password for instance only at ``create``\ \ and\n``rebuild`` process.\n\nThere is no agent needed within the image to\ \ do this. If *libguestfs* is\navailable on the host, it will be used. Otherwise\ \ *nbd* is used. The file\nsystem of the image will be mounted and the admin\ \ password, which is provided\nin the REST API call will be injected as password\ \ for the root user. If no\nroot user is available, the instance won't be\ \ launched and an error is thrown.\nBe aware that the injection is *not* possible\ \ when the instance gets launched\nfrom a volume.\n\nPossible values:\n\n\ * True: Allows the injection.\n* False (default): Disallows the injection.\ \ Any via the REST API provided\nadmin password will be silently ignored.\n\ \nRelated options:\n\n* ``inject_partition``: That option will decide about\ \ the discovery and usage\n of the file system. It also can disable the injection\ \ at all.\n" max: null metavar: null min: null mutable: false name: inject_password namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: inject_key help: "\nAllow the injection of an SSH key at boot time.\n\nThere is no agent\ \ needed within the image to do this. If *libguestfs* is\navailable on the\ \ host, it will be used. Otherwise *nbd* is used. The file\nsystem of the\ \ image will be mounted and the SSH key, which is provided\nin the REST API\ \ call will be injected as SSH key for the root user and\nappended to the\ \ ``authorized_keys`` of that user. The SELinux context will\nbe set if necessary.\ \ Be aware that the injection is *not* possible when the\ninstance gets launched\ \ from a volume.\n\nThis config option will enable directly modifying the\ \ instance disk and does\nnot affect what cloud-init may do using data from\ \ config_drive option or the\nmetadata service.\n\nRelated options:\n\n* ``inject_partition``:\ \ That option will decide about the discovery and usage\n of the file system.\ \ It also can disable the injection at all.\n" max: null metavar: null min: null mutable: false name: inject_key namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: -2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: inject_partition help: "\nDetermines the way how the file system is chosen to inject data into\ \ it.\n\n*libguestfs* will be used a first solution to inject data. If that's\ \ not\navailable on the host, the image will be locally mounted on the host\ \ as a\nfallback solution. If libguestfs is not able to determine the root\ \ partition\n(because there are more or less than one root partition) or cannot\ \ mount the\nfile system it will result in an error and the instance won't\ \ be boot.\n\nPossible values:\n\n* -2 => disable the injection of data.\n\ * -1 => find the root partition with the file system to mount with libguestfs\n\ * 0 => The image is not partitioned\n* >0 => The number of the partition\ \ to use for the injection\n\nRelated options:\n\n* ``inject_key``: If this\ \ option allows the injection of a SSH key it depends\n on value greater\ \ or equal to -1 for ``inject_partition``.\n* ``inject_password``: If this\ \ option allows the injection of an admin password\n it depends on value\ \ greater or equal to -1 for ``inject_partition``.\n* ``guestfs`` You can\ \ enable the debug log level of libguestfs with this\n config option. A more\ \ verbose output will help in debugging issues.\n* ``virt_type``: If you use\ \ ``lxc`` as virt_type it will be treated as a\n single partition image\n" max: null metavar: null min: -2 mutable: false name: inject_partition namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: true deprecated_opts: [] deprecated_reason: This option is being replaced by the 'pointer_model' option. deprecated_since: 14.0.0 dest: use_usb_tablet help: "\nEnable a mouse cursor within a graphical VNC or SPICE sessions.\n\n\ This will only be taken into account if the VM is fully virtualized and VNC\n\ and/or SPICE is enabled. If the node doesn't support a graphical framebuffer,\n\ then it is valid to set this to False.\n\nRelated options:\n* ``[vnc]enabled``:\ \ If VNC is enabled, ``use_usb_tablet`` will have an effect.\n* ``[spice]enabled``\ \ + ``[spice].agent_enabled``: If SPICE is enabled and the\n spice agent\ \ is disabled, the config value of ``use_usb_tablet`` will have\n an effect.\n" max: null metavar: null min: null mutable: false name: use_usb_tablet namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_inbound_addr help: ' The IP address or hostname to be used as the target for live migration traffic. If this option is set to None, the hostname of the migration target compute node will be used. This option is useful in environments where the live-migration traffic can impact the network plane significantly. A separate network for live-migration traffic can then use this config option and avoids the impact on the management network. Possible values: * A valid IP address or hostname, else None. ' max: null metavar: null min: null mutable: false name: live_migration_inbound_addr namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' live_migration_uri is deprecated for removal in favor of two other options that allow to change live migration scheme and target URI: ``live_migration_scheme`` and ``live_migration_inbound_addr`` respectively. ' deprecated_since: 15.0.0 dest: live_migration_uri help: "\nLive migration target URI to use.\n\nOverride the default libvirt live\ \ migration target URI (which is dependent\non virt_type). Any included \"\ %s\" is replaced with the migration target\nhostname.\n\nIf this option is\ \ set to None (which is the default), Nova will automatically\ngenerate the\ \ `live_migration_uri` value based on only 3 supported `virt_type`\nin following\ \ list:\n* 'kvm': 'qemu+tcp://%s/system'\n* 'qemu': 'qemu+tcp://%s/system'\n\ * 'xen': 'xenmigr://%s/system'\n\nRelated options:\n* ``live_migration_inbound_addr``:\ \ If ``live_migration_inbound_addr`` value\n is not None, the ip/hostname\ \ address of target compute node is used instead\n of ``live_migration_uri``\ \ as the uri for live migration.\n* ``live_migration_scheme``: If ``live_migration_uri``\ \ is not set, the scheme\n used for live migration is taken from ``live_migration_scheme``\ \ instead.\n" max: null metavar: null min: null mutable: false name: live_migration_uri namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_scheme help: "\nSchema used for live migration.\n\nOverride the default libvirt live\ \ migration scheme (which is dependant on\nvirt_type). If this option is set\ \ to None, nova will automatically choose a\nsensible default based on the\ \ hypervisor. It is not recommended that you change\nthis unless you are very\ \ sure that hypervisor supports a particular scheme.\n\nRelated options:\n\ * ``virt_type``: This option is meaningful only when ``virt_type`` is set\ \ to\n `kvm` or `qemu`.\n* ``live_migration_uri``: If ``live_migration_uri``\ \ value is not None, the\n scheme used for live migration is taken from ``live_migration_uri``\ \ instead.\n" max: null metavar: null min: null mutable: false name: live_migration_scheme namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_tunnelled help: "\nEnable tunnelled migration.\n\nThis option enables the tunnelled migration\ \ feature, where migration data is\ntransported over the libvirtd connection.\ \ If enabled, we use the\nVIR_MIGRATE_TUNNELLED migration flag, avoiding the\ \ need to configure\nthe network to allow direct hypervisor to hypervisor\ \ communication.\nIf False, use the native transport. If not set, Nova will\ \ choose a\nsensible default based on, for example the availability of native\n\ encryption support in the hypervisor. Enable this option will definitely\n\ impact performance massively.\n\nNote that this option is NOT compatible with\ \ use of block migration.\n\nPossible values:\n\n* Supersedes and (if set)\ \ overrides the deprecated 'live_migration_flag' and\n 'block_migration_flag'\ \ to enable tunneled migration.\n" max: null metavar: null min: null mutable: false name: live_migration_tunnelled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_bandwidth help: ' Maximum bandwidth(in MiB/s) to be used during migration. If set to 0, the hypervisor will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. Please refer to the libvirt documentation for further details. ' max: null metavar: null min: null mutable: false name: live_migration_bandwidth namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 500 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_downtime help: ' Maximum permitted downtime, in milliseconds, for live migration switchover. Will be rounded up to a minimum of 100ms. You can increase this value if you want to allow live-migrations to complete faster, or avoid live-migration timeout errors by allowing the guest to be paused for longer during the live-migration switch over. Related options: * live_migration_completion_timeout ' max: null metavar: null min: 100 mutable: false name: live_migration_downtime namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_downtime_steps help: ' Number of incremental steps to reach max downtime value. Will be rounded up to a minimum of 3 steps. ' max: null metavar: null min: 3 mutable: false name: live_migration_downtime_steps namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 75 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_downtime_delay help: ' Time to wait, in seconds, between each step increase of the migration downtime. Minimum delay is 3 seconds. Value is per GiB of guest RAM + disk to be transferred, with lower bound of a minimum of 2 GiB per device. ' max: null metavar: null min: 3 mutable: false name: live_migration_downtime_delay namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 800 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_completion_timeout help: ' 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. Related options: * live_migration_downtime * live_migration_downtime_steps * live_migration_downtime_delay ' max: null metavar: null min: null mutable: true name: live_migration_completion_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Serious bugs found in this feature. deprecated_since: null dest: live_migration_progress_timeout help: ' Time to wait, in seconds, for migration to make forward progress in transferring data before aborting the operation. Set to 0 to disable timeouts. This is deprecated, and now disabled by default because we have found serious bugs in this feature that caused false live-migration timeout failures. This feature will be removed or replaced in a future release. ' max: null metavar: null min: null mutable: true name: live_migration_progress_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_permit_post_copy help: "\nThis option allows nova to switch an on-going live migration to post-copy\n\ mode, i.e., switch the active VM to the one on the destination node before\ \ the\nmigration is complete, therefore ensuring an upper bound on the memory\ \ that\nneeds to be transferred. Post-copy requires libvirt>=1.3.3 and QEMU>=2.5.0.\n\ \nWhen permitted, post-copy mode will be automatically activated if a\nlive-migration\ \ memory copy iteration does not make percentage increase of at\nleast 10%\ \ over the last iteration.\n\nThe live-migration force complete API also uses\ \ post-copy when permitted. If\npost-copy mode is not available, force complete\ \ falls back to pausing the VM\nto ensure the live-migration operation will\ \ complete.\n\nWhen using post-copy mode, if the source and destination hosts\ \ loose network\nconnectivity, the VM being live-migrated will need to be\ \ rebooted. For more\ndetails, please see the Administration guide.\n\nRelated\ \ options:\n\n * live_migration_permit_auto_converge\n" max: null metavar: null min: null mutable: false name: live_migration_permit_post_copy namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: live_migration_permit_auto_converge help: "\nThis option allows nova to start live migration with auto converge\ \ on.\n\nAuto converge throttles down CPU if a progress of on-going live migration\n\ is slow. Auto converge will only be used if this flag is set to True and\n\ post copy is not permitted or post copy is unavailable due to the version\n\ of libvirt and QEMU in use. Auto converge requires libvirt>=1.2.3 and\nQEMU>=1.6.0.\n\ \nRelated options:\n\n * live_migration_permit_post_copy\n" max: null metavar: null min: null mutable: false name: live_migration_permit_auto_converge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: - raw - qcow2 - vmdk - vdi default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: snapshot_image_format help: ' Determine the snapshot image format when sending to the image service. If set, this decides what format is used when sending the snapshot to the image service. If not set, defaults to same type as source image. Possible values: * ``raw``: RAW disk format * ``qcow2``: KVM default disk format * ``vmdk``: VMWare default disk format * ``vdi``: VirtualBox default disk format * If not set, defaults to same type as source image. ' max: null metavar: null min: null mutable: false name: snapshot_image_format namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disk_prefix help: "\nOverride the default disk prefix for the devices attached to an instance.\n\ \nIf set, this is used to identify a free disk device name for a bus.\n\n\ Possible values:\n\n* Any prefix which will result in a valid disk device\ \ name like 'sda' or 'hda'\n for example. This is only necessary if the device\ \ names differ to the\n commonly known device name prefixes for a virtualization\ \ type such as: sd,\n xvd, uvd, vd.\n\nRelated options:\n\n* ``virt_type``:\ \ Influences which device type is used, which determines\n the default disk\ \ prefix.\n" max: null metavar: null min: null mutable: false name: disk_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 120 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: wait_soft_reboot_seconds help: Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window. max: null metavar: null min: null mutable: false name: wait_soft_reboot_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - host-model - host-passthrough - custom - none default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cpu_mode help: "\nIs used to set the CPU mode an instance should have.\n\nIf virt_type=\"\ kvm|qemu\", it will default to \"host-model\", otherwise it will\ndefault\ \ to \"none\".\n\nPossible values:\n\n* ``host-model``: Clones the host CPU\ \ feature flags.\n* ``host-passthrough``: Use the host CPU model exactly;\n\ * ``custom``: Use a named CPU model;\n* ``none``: Not set any CPU model.\n\ \nRelated options:\n\n* ``cpu_model``: If ``custom`` is used for ``cpu_mode``,\ \ set this config\n option too, otherwise this would result in an error and\ \ the instance won't\n be launched.\n" max: null metavar: null min: null mutable: false name: cpu_mode namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cpu_model help: "\nSet the name of the libvirt CPU model the instance should use.\n\n\ Possible values:\n\n* The names listed in /usr/share/libvirt/cpu_map.xml\n\ \nRelated options:\n\n* ``cpu_mode``: Don't set this when ``cpu_mode`` is\ \ NOT set to ``custom``.\n This would result in an error and the instance\ \ won't be launched.\n* ``virt_type``: Only the virtualization types ``kvm``\ \ and ``qemu`` use this.\n" max: null metavar: null min: null mutable: false name: cpu_model namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $instances_path/snapshots deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: snapshots_directory help: Location where libvirt driver will store snapshots before uploading them to image service max: null metavar: null min: null mutable: false name: snapshots_directory namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /usr/lib/xen/boot/hvmloader deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: xen_hvmloader_path help: Location where the Xen hvmloader is kept max: null metavar: null min: null mutable: false name: xen_hvmloader_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disk_cachemodes help: 'Specific cachemodes to use for different disk types e.g: file=directsync,block=none' max: null metavar: null min: null mutable: false name: disk_cachemodes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rng_dev_path help: 'A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng' max: null metavar: null min: null mutable: false name: rng_dev_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: hw_machine_type help: 'For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2' max: null metavar: null min: null mutable: false name: hw_machine_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: - none - os - hardware - auto default: auto deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sysinfo_serial help: The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. max: null metavar: null min: null mutable: false name: sysinfo_serial namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mem_stats_period_seconds help: A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics. max: null metavar: null min: null mutable: false name: mem_stats_period_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: uid_maps help: List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed. max: null metavar: null min: null mutable: false name: uid_maps namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: gid_maps help: List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed. max: null metavar: null min: null mutable: false name: gid_maps namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: realtime_scheduler_priority help: In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99) max: null metavar: null min: null mutable: false name: realtime_scheduler_priority namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled_perf_events help: "\nThis is a performance event list which could be used as monitor. These\ \ events\nwill be passed to libvirt domain xml while creating a new instances.\n\ Then event statistics data can be collected from libvirt. The minimum\nlibvirt\ \ version is 2.0.0. For more information about `Performance monitoring\nevents`,\ \ refer https://libvirt.org/formatdomain.html#elementsPerf .\n\nPossible values:\n\ * A string list. For example: ``enabled_perf_events = cmt, mbml, mbmt``\n\ \ The supported events list can be found in\n https://libvirt.org/html/libvirt-libvirt-domain.html\ \ ,\n which you may need to search key words ``VIR_PERF_PARAM_*``\n" max: null metavar: null min: null mutable: false name: enabled_perf_events namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: - raw - flat - qcow2 - lvm - rbd - ploop - default default: default deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: images_type help: ' VM Images format. If default is specified, then use_cow_images flag is used instead of this one. Related options: * virt.use_cow_images * images_volume_group ' max: null metavar: null min: null mutable: false name: images_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: images_volume_group help: ' LVM Volume Group that is used for VM images, when you specify images_type=lvm Related options: * images_type ' max: null metavar: null min: null mutable: false name: images_volume_group namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sparse_logical_volumes help: ' Create sparse logical volumes (with virtualsize) if this flag is set to True. ' max: null metavar: null min: null mutable: false name: sparse_logical_volumes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: rbd deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: images_rbd_pool help: The RADOS pool in which rbd volumes are stored max: null metavar: null min: null mutable: false name: images_rbd_pool namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: images_rbd_ceph_conf help: Path to the ceph configuration file to use max: null metavar: null min: null mutable: false name: images_rbd_ceph_conf namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - ignore - unmap default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: hw_disk_discard help: ' Discard option for nova managed disks. Requires: * Libvirt >= 1.0.6 * Qemu >= 1.5 (raw format) * Qemu >= 1.6 (qcow2 format) ' max: null metavar: null min: null mutable: false name: hw_disk_discard namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $instances_path/$image_cache_subdirectory_name/%(image)s.info deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Image info files are no longer used by the image cache deprecated_since: 14.0.0 dest: image_info_filename_pattern help: Allows image information files to be stored in non-standard locations max: null metavar: null min: null mutable: false name: image_info_filename_pattern namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: remove_unused_resized_minimum_age_seconds help: Unused resized base images younger than this will not be removed max: null metavar: null min: null mutable: false name: remove_unused_resized_minimum_age_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: The image cache no longer periodically calculates checksums of stored images. Data integrity can be checked at the block or filesystem level. deprecated_since: 14.0.0 dest: checksum_base_images help: Write a checksum for files in _base to disk max: null metavar: null min: null mutable: false name: checksum_base_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 3600 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: The image cache no longer periodically calculates checksums of stored images. Data integrity can be checked at the block or filesystem level. deprecated_since: 14.0.0 dest: checksum_interval_seconds help: How frequently to checksum base images max: null metavar: null min: null mutable: false name: checksum_interval_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - none - zero - shred default: zero deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: volume_clear help: ' Method used to wipe ephemeral disks when they are deleted. Only takes effect if LVM is set as backing storage. Possible values: * none - do not wipe deleted volumes * zero - overwrite volumes with zeroes * shred - overwrite volume repeatedly Related options: * images_type - must be set to ``lvm`` * volume_clear_size ' max: null metavar: null min: null mutable: false name: volume_clear namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: volume_clear_size help: "\nSize of area in MiB, counting from the beginning of the allocated volume,\n\ that will be cleared using method set in ``volume_clear`` option.\n\nPossible\ \ values:\n\n* 0 - clear whole volume\n* >0 - clear specified amount of MiB\n\ \nRelated options:\n\n* images_type - must be set to ``lvm``\n* volume_clear\ \ - must be set and the value must be different than ``none``\n for this\ \ option to have any impact\n" max: null metavar: null min: 0 mutable: false name: volume_clear_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: snapshot_compression help: ' Enable snapshot compression for ``qcow2`` images. Note: you can set ``snapshot_image_format`` to ``qcow2`` to force all snapshots to be in ``qcow2`` format, independently from their original image type. Related options: * snapshot_image_format ' max: null metavar: null min: null mutable: false name: snapshot_compression namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_virtio_for_bridges help: Use virtio for bridge interfaces with KVM/QEMU max: null metavar: null min: null mutable: false name: use_virtio_for_bridges namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: qemu_allowed_storage_drivers help: ' Protocols listed here will be accessed directly from QEMU. If gluster is present in qemu_allowed_storage_drivers, glusterfs''s backend will pass a disk configuration to QEMU. This allows QEMU to access the volume using libgfapi rather than mounting GlusterFS via fuse. Possible values: * [gluster] ' max: null metavar: null min: null mutable: false name: qemu_allowed_storage_drivers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: libvirt name: iscsi_use_multipath deprecated_reason: null deprecated_since: null dest: volume_use_multipath help: ' Use multipath connection of the iSCSI or FC volume Volumes can be connected in the LibVirt as multipath devices. This will provide high availability and fault tolerance. ' max: null metavar: null min: null mutable: false name: volume_use_multipath namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: num_aoe_discover_tries help: ' Number of times to rediscover AoE target to find volume. Nova provides support for block storage attaching to hosts via AOE (ATA over Ethernet). This option allows the user to specify the maximum number of retry attempts that can be made to discover the AoE device. ' max: null metavar: null min: null mutable: false name: num_aoe_discover_tries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: $state_path/mnt deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: glusterfs_mount_point_base help: ' Absolute path to the directory where the glusterfs volume is mounted on the compute node. ' max: null metavar: null min: null mutable: false name: glusterfs_mount_point_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: num_iscsi_scan_tries help: ' Number of times to scan iSCSI target to find volume. ' max: null metavar: null min: null mutable: false name: num_iscsi_scan_tries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: libvirt name: iscsi_transport deprecated_reason: null deprecated_since: null dest: iscsi_iface help: ' The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form . where is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name. ' max: null metavar: null min: null mutable: false name: iscsi_iface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: num_iser_scan_tries help: ' Number of times to scan iSER target to find volume. iSER is a server network protocol that extends iSCSI protocol to use Remote Direct Memory Access (RDMA). This option allows the user to specify the maximum number of scan attempts that can be made to find iSER volume. ' max: null metavar: null min: null mutable: false name: num_iser_scan_tries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: iser_use_multipath help: ' Use multipath connection of the iSER volume. iSER volumes can be connected as multipath devices. This will provide high availability and fault tolerance. ' max: null metavar: null min: null mutable: false name: iser_use_multipath namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rbd_user help: ' The RADOS client name for accessing rbd(RADOS Block Devices) volumes. Libvirt will refer to this user when connecting and authenticating with the Ceph RBD server. ' max: null metavar: null min: null mutable: false name: rbd_user namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rbd_secret_uuid help: ' The libvirt UUID of the secret for the rbd_user volumes. ' max: null metavar: null min: null mutable: false name: rbd_secret_uuid namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/mnt deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: nfs_mount_point_base help: ' Directory where the NFS volume is mounted on the compute node. The default is ''mnt'' directory of the location where nova''s Python module is installed. NFS provides shared storage for the OpenStack Block Storage service. Possible values: * A string representing absolute path of mount point. ' max: null metavar: null min: null mutable: false name: nfs_mount_point_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: nfs_mount_options help: ' Mount options passed to the NFS client. See section of the nfs man page for details. Mount options controls the way the filesystem is mounted and how the NFS client behaves when accessing files on this mount point. Possible values: * Any string representing mount options separated by commas. * Example string: vers=3,lookupcache=pos ' max: null metavar: null min: null mutable: false name: nfs_mount_options namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/mnt deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: quobyte_mount_point_base help: ' Directory where the Quobyte volume is mounted on the compute node. Nova supports Quobyte volume driver that enables storing Block Storage service volumes on a Quobyte storage back end. This Option sepcifies the path of the directory where Quobyte volume is mounted. Possible values: * A string representing absolute path of mount point. ' max: null metavar: null min: null mutable: false name: quobyte_mount_point_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: quobyte_client_cfg help: Path to a Quobyte Client configuration file. max: null metavar: null min: null mutable: false name: quobyte_client_cfg namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scality_sofs_config help: ' Path or URL to Scality SOFS(Scale-Out File Server) configuration file. The Scality SOFS provides OpenStack users the option of storing their data on a high capacity, replicated, highly available Scality Ring object storage cluster. ' max: null metavar: null min: null mutable: false name: scality_sofs_config namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/scality deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scality_sofs_mount_point help: "\nBase dir where Scality SOFS shall be mounted.\n\nThe Scality volume\ \ driver in Nova mounts SOFS and lets the hypervisor access\nthe volumes.\n\ \nPossible values:\n\n* $state_path/scality where state_path is a config option\ \ that specifies\n the top-level directory for maintaining nova's state or\ \ Any string\n containing the full directory path.\n" max: null metavar: null min: null mutable: false name: scality_sofs_mount_point namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/mnt deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: smbfs_mount_point_base help: ' Directory where the SMBFS shares are mounted on the compute node. ' max: null metavar: null min: null mutable: false name: smbfs_mount_point_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: smbfs_mount_options help: ' Mount options passed to the SMBFS client. Provide SMBFS options as a single string containing all parameters. See mount.cifs man page for details. Note that the libvirt-qemu ``uid`` and ``gid`` must be specified. ' max: null metavar: null min: null mutable: false name: smbfs_mount_options namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - ssh - rsync default: ssh deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: remote_filesystem_transport help: ' libvirt''s transport method for remote file operations. Because libvirt cannot use RPC to copy files over network to/from other compute nodes, other method must be used for: * creating directory on remote host * creating file on remote host * removing file from remote host * copying file to remote host ' max: null metavar: null min: null mutable: false name: remote_filesystem_transport namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $state_path/mnt deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_mount_point_base help: ' Directory where the Virtuozzo Storage clusters are mounted on the compute node. This option defines non-standard mountpoint for Vzstorage cluster. Related options: * vzstorage_mount_* group of parameters ' max: null metavar: null min: null mutable: false name: vzstorage_mount_point_base namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: stack deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_mount_user help: ' Mount owner user name. This option defines the owner user of Vzstorage cluster mountpoint. Related options: * vzstorage_mount_* group of parameters ' max: null metavar: null min: null mutable: false name: vzstorage_mount_user namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: qemu deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_mount_group help: ' Mount owner group name. This option defines the owner group of Vzstorage cluster mountpoint. Related options: * vzstorage_mount_* group of parameters ' max: null metavar: null min: null mutable: false name: vzstorage_mount_group namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '0770' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_mount_perms help: ' Mount access mode. This option defines the access bits of Vzstorage cluster mountpoint, in the format similar to one of chmod(1) utility, like this: 0770. It consists of one to four digits ranging from 0 to 7, with missing lead digits assumed to be 0''s. Related options: * vzstorage_mount_* group of parameters ' max: null metavar: null min: null mutable: false name: vzstorage_mount_perms namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /var/log/pstorage/%(cluster_name)s/nova.log.gz deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_log_path help: ' 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. Related options: * vzstorage_mount_opts may include more detailed logging options. ' max: null metavar: null min: null mutable: false name: vzstorage_log_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_cache_path help: ' Path to the SSD cache file. You can attach an SSD drive to a client and configure the drive to store a local cache of frequently accessed data. By having a local cache on a client''s SSD drive, you can increase the overall cluster performance by up to 10 and more times. WARNING! There is a lot of SSD models which are not server grade and may loose arbitrary set of data changes on power loss. Such SSDs should not be used in Vstorage and are dangerous as may lead to data corruptions and inconsistencies. Please consult with the manual on which SSD models are known to be safe or verify it using vstorage-hwflush-check(1) utility. This option defines the path which should include "%(cluster_name)s" template to separate caches from multiple shares. Related options: * vzstorage_mount_opts may include more detailed cache options. ' max: null metavar: null min: null mutable: false name: vzstorage_cache_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vzstorage_mount_opts help: ' 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. Related options: * All other vzstorage_* options ' max: null metavar: null min: null mutable: false name: vzstorage_mount_opts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value matchmaker_redis: help: null opts: - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: host help: Host to locate redis. max: null metavar: null min: null mutable: false name: host namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 6379 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: port help: Use this port to connect to redis host. max: 65535 metavar: null min: 0 mutable: false name: port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: '' deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: password help: Password for Redis server (optional). max: null metavar: null min: null mutable: false name: password namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: [] deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: sentinel_hosts help: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port ... ] max: null metavar: null min: null mutable: false name: sentinel_hosts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: oslo-messaging-zeromq deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sentinel_group_name help: Redis replica set name. max: null metavar: null min: null mutable: false name: sentinel_group_name namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 2000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: wait_timeout help: Time in ms to wait between connection attempts. max: null metavar: null min: null mutable: false name: wait_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 20000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: check_timeout help: Time in ms to wait before the transaction is killed. max: null metavar: null min: null mutable: false name: check_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: socket_timeout help: Timeout in ms on blocking socket operations. max: null metavar: null min: null mutable: false name: socket_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value metrics: help: ' Configuration options for metrics Options under this group allow to adjust how values assigned to metrics are calculated. ' opts: - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: weight_multiplier help: "\nWhen using metrics to weight the suitability of a host, you can use\ \ this option\nto change how the calculated weight influences the weight assigned\ \ to a host as\nfollows:\n\n* >1.0: increases the effect of the metric on\ \ overall weight\n* 1.0: no change to the calculated weight\n* >0.0,<1.0:\ \ reduces the effect of the metric on overall weight\n* 0.0: the metric value\ \ is ignored, and the value of the\n 'weight_of_unavailable' option is returned\ \ instead\n* >-1.0,<0.0: the effect is reduced and reversed\n* -1.0: the effect\ \ is reversed\n* <-1.0: the effect is increased proportionally and reversed\n\ \nThis option is only used by the FilterScheduler and its subclasses; if you\ \ use\na different scheduler, this option has no effect.\n\nPossible values:\n\ \n* An integer or float value, where the value corresponds to the multipler\n\ \ ratio for this weigher.\n\nRelated options:\n\n* weight_of_unavailable\n" max: null metavar: null min: null mutable: false name: weight_multiplier namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: weight_setting help: "\nThis setting specifies the metrics to be weighed and the relative ratios\ \ for\neach metric. This should be a single string value, consisting of a\ \ series of\none or more 'name=ratio' pairs, separated by commas, where 'name'\ \ is the name\nof the metric to be weighed, and 'ratio' is the relative weight\ \ for that\nmetric.\n\nNote that if the ratio is set to 0, the metric value\ \ is ignored, and instead\nthe weight will be set to the value of the 'weight_of_unavailable'\ \ option.\n\nAs an example, let's consider the case where this option is set\ \ to:\n\n ``name1=1.0, name2=-1.3``\n\nThe final weight will be:\n\n \ \ ``(name1.value * 1.0) + (name2.value * -1.3)``\n\nThis option is only used\ \ by the FilterScheduler and its subclasses; if you use\na different scheduler,\ \ this option has no effect.\n\nPossible values:\n\n* A list of zero or more\ \ key/value pairs separated by commas, where the key is\n a string representing\ \ the name of a metric and the value is a numeric weight\n for that metric.\ \ If any value is set to 0, the value is ignored and the\n weight will be\ \ set to the value of the 'weight_of_unavailable' option.\n\nRelated options:\n\ \n* weight_of_unavailable\n" max: null metavar: null min: null mutable: false name: weight_setting namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: required help: "\nThis setting determines how any unavailable metrics are treated. If\ \ this option\nis set to True, any hosts for which a metric is unavailable\ \ will raise an\nexception, so it is recommended to also use the MetricFilter\ \ to filter out\nthose hosts before weighing.\n\nThis option is only used\ \ by the FilterScheduler and its subclasses; if you use\na different scheduler,\ \ this option has no effect.\n\nPossible values:\n\n* True or False, where\ \ False ensures any metric being unavailable for a host\n will set the host\ \ weight to 'weight_of_unavailable'.\n\nRelated options:\n\n* weight_of_unavailable\n" max: null metavar: null min: null mutable: false name: required namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: -10000.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: weight_of_unavailable help: "\nWhen any of the following conditions are met, this value will be used\ \ in place\nof any actual metric value:\n\n* One of the metrics named in 'weight_setting'\ \ is not available for a host,\n and the value of 'required' is False\n*\ \ The ratio specified for a metric in 'weight_setting' is 0\n* The 'weight_multiplier'\ \ option is set to 0\n\nThis option is only used by the FilterScheduler and\ \ its subclasses; if you use\na different scheduler, this option has no effect.\n\ \nPossible values:\n\n* An integer or float value, where the value corresponds\ \ to the multipler\n ratio for this weigher.\n\nRelated options:\n\n* weight_setting\n\ * required\n* weight_multiplier\n" max: null metavar: null min: null mutable: false name: weight_of_unavailable namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value mks: help: ' Nova compute node uses WebMKS, a desktop sharing protocol to provide instance console access to VM''s created by VMware hypervisors. Related options: Following options must be set to provide console access. * mksproxy_base_url * enabled ' opts: - advanced: false choices: null default: http://127.0.0.1:6090/ deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mksproxy_base_url help: ' 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/`` ' max: null metavar: null min: null mutable: false name: mksproxy_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: ' Enables graphical console access for virtual machines. ' max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value neutron: help: ' Configuration options for neutron (network connectivity as a service). ' opts: - advanced: false choices: null default: http://127.0.0.1:9696 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: url help: "\nThis option specifies the URL for connecting to Neutron.\n\nPossible\ \ values:\n\n* Any valid URL that points to the Neutron API service is appropriate\ \ here.\n This typically matches the URL returned for the 'network' service\ \ type\n from the Keystone service catalog.\n" max: null metavar: null min: null mutable: false name: url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: RegionOne deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: region_name help: ' Region name for connecting to Neutron in admin context. This option is used in multi-region setups. If there are two Neutron servers running in two regions in two different machines, then two services need to be created in Keystone with two different regions and associate corresponding endpoints to those services. When requests are made to Keystone, the Keystone service uses the region_name to determine the region the request is coming from. ' max: null metavar: null min: null mutable: false name: region_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: br-int deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ovs_bridge help: ' 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. ' max: null metavar: null min: null mutable: false name: ovs_bridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: extension_sync_interval help: ' Integer value representing the number of seconds to wait before querying Neutron for extensions. After this number of seconds the next time Nova needs to create a resource in Neutron it will requery Neutron for the extensions that it has loaded. Setting value to 0 will refresh the extensions with no wait. ' max: null metavar: null min: 0 mutable: false name: extension_sync_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: service_metadata_proxy help: ' 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 ' max: null metavar: null min: null mutable: false name: service_metadata_proxy namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: metadata_proxy_shared_secret help: ' This option holds the shared secret string used to validate proxy requests to Neutron metadata requests. In order to be used, the ''X-Metadata-Provider-Signature'' header must be supplied in the request. Related options: * service_metadata_proxy ' max: null metavar: null min: null mutable: false name: metadata_proxy_shared_secret namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: PEM encoded Certificate Authority to use when verifying HTTPs connections. max: null metavar: null min: null mutable: false name: cafile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: PEM encoded client certificate cert file max: null metavar: null min: null mutable: false name: certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: PEM encoded client certificate key file max: null metavar: null min: null mutable: false name: keyfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout help: Timeout value for http requests max: null metavar: null min: null mutable: false name: timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: neutron name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_url help: Authentication URL max: null metavar: null min: null mutable: false name: auth-url namespace: nova.conf positional: false required: true sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID to scope to max: null metavar: null min: null mutable: false name: domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name to scope to max: null metavar: null min: null mutable: false name: domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID to scope to max: null metavar: null min: null mutable: false name: project-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name to scope to max: null metavar: null min: null mutable: false name: project-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Domain ID containing project max: null metavar: null min: null mutable: false name: project-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Domain name containing project max: null metavar: null min: null mutable: false name: project-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID max: null metavar: null min: null mutable: false name: trust-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_id help: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_name help: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID max: null metavar: null min: null mutable: false name: user-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: neutron name: user_name deprecated_reason: null deprecated_since: null dest: username help: Username max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain id max: null metavar: null min: null mutable: false name: user-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name max: null metavar: null min: null mutable: false name: user-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: User's password max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_id help: Tenant ID max: null metavar: null min: null mutable: false name: tenant-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_name help: Tenant Name max: null metavar: null min: null mutable: false name: tenant-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value notifications: help: ' Most of the actions in Nova which manipulate the system state generate notifications which are posted to the messaging component (e.g. RabbitMQ) and can be consumed by any service outside the Openstack. More technical details at http://docs.openstack.org/developer/nova/notifications.html ' opts: - advanced: false choices: - null - vm_state - vm_and_task_state default: null deprecated_for_removal: false deprecated_opts: - group: default name: notify_on_state_change deprecated_reason: null deprecated_since: null dest: notify_on_state_change help: ' If set, send compute.instance.update notifications on instance state changes. Please refer to https://wiki.openstack.org/wiki/SystemUsageData for additional information on notifications. Possible values: * None - no notifications * "vm_state" - notifications on VM state changes * "vm_and_task_state" - notifications on VM and task state changes ' max: null metavar: null min: null mutable: false name: notify_on_state_change namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: default name: notify_api_faults deprecated_reason: null deprecated_since: null dest: notify_on_api_faults help: ' If enabled, send api.fault notifications on caught exceptions in the API service. ' max: null metavar: null min: null mutable: false name: notify_on_api_faults namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: - DEBUG - INFO - WARN - ERROR - CRITICAL default: INFO deprecated_for_removal: false deprecated_opts: - group: default name: default_notification_level deprecated_reason: null deprecated_since: null dest: default_level help: Default notification level for outgoing notifications. max: null metavar: null min: null mutable: false name: default_level namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: $my_ip deprecated_for_removal: false deprecated_opts: - group: default name: default_publisher_id deprecated_reason: null deprecated_since: null dest: default_publisher_id help: "\nDefault publisher_id for outgoing notifications. If you consider routing\n\ notifications using different publisher, change this value accordingly.\n\n\ Possible values:\n\n* Defaults to the IPv4 address of this host, but it can\ \ be any valid\n oslo.messaging publisher_id\n\nRelated options:\n\n* my_ip\ \ - IP address of this host\n" max: null metavar: null min: null mutable: false name: default_publisher_id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - unversioned - versioned - both default: both deprecated_for_removal: false deprecated_opts: - group: default name: notification_format deprecated_reason: null deprecated_since: null dest: notification_format help: "\nSpecifies which notification format shall be used by nova.\n\nThe default\ \ value is fine for most deployments and rarely needs to be changed.\nThis\ \ value can be set to 'versioned' once the infrastructure moves closer to\n\ consuming the newer format of notifications. After this occurs, this option\n\ will be removed (possibly in the \"P\" release).\n\nPossible values:\n* unversioned:\ \ Only the legacy unversioned notifications are emitted.\n* versioned: Only\ \ the new versioned notifications are emitted.\n* both: Both the legacy unversioned\ \ and the new versioned notifications are\n emitted. (Default)\n\nThe list\ \ of versioned notifications is visible in\nhttp://docs.openstack.org/developer/nova/notifications.html\n" max: null metavar: null min: null mutable: false name: notification_format namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value osapi_v21: help: null opts: - advanced: false choices: null default: [] deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' API extensions are now part of the standard API. API extensions should be disabled using policy, rather than via these configuration options.' deprecated_since: 12.0.0 dest: extensions_blacklist help: "\nThis option is a list of all of the v2.1 API extensions to never load.\n\ \nPossible values:\n\n* A list of strings, each being the alias of an extension\ \ that you do not\n wish to load.\n\nRelated options:\n\n* enabled\n* extensions_whitelist\n" max: null metavar: null min: null mutable: false name: extensions_blacklist namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: [] deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' API extensions are now part of the standard API. API extensions should be disabled using policy, rather than via these configuration options.' deprecated_since: 12.0.0 dest: extensions_whitelist help: "\nThis is a list of extensions. If it is empty, then *all* extensions\ \ except\nthose specified in the extensions_blacklist option will be loaded.\ \ If it is not\nempty, then only those extensions in this list will be loaded,\ \ provided that\nthey are also not in the extensions_blacklist option.\n\n\ Possible values:\n\n* A list of strings, each being the alias of an extension\ \ that you wish to\n load, or an empty list, which indicates that all extensions\ \ are to be run.\n\nRelated options:\n\n* enabled\n* extensions_blacklist\n" max: null metavar: null min: null mutable: false name: extensions_whitelist namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' Recent versions of nova constrain project IDs to hexadecimal characters and dashes. If your installation uses IDs outside of this range, you should use this option to provide your own regex and give you time to migrate offending projects to valid IDs before the next release.' deprecated_since: 13.0.0 dest: project_id_regex help: ' This option is a string representing a regular expression (regex) that matches the project_id as contained in URLs. If not set, it will match normal UUIDs created by keystone. Possible values: * A string representing any legal regular expression ' max: null metavar: null min: null mutable: false name: project_id_regex namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value oslo_concurrency: help: null opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: disable_process_locking deprecated_reason: null deprecated_since: null dest: disable_process_locking help: Enables or disables inter-process locks. max: null metavar: null min: null mutable: false name: disable_process_locking namespace: oslo.concurrency positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: lock_path deprecated_reason: null deprecated_since: null dest: lock_path help: Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. max: null metavar: null min: null mutable: false name: lock_path namespace: oslo.concurrency positional: false required: false sample_default: null secret: false short: null type: string value oslo_messaging_amqp: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: amqp1 name: container_name deprecated_reason: null deprecated_since: null dest: container_name help: Name for the AMQP container. must be globally unique. Defaults to a generated UUID max: null metavar: null min: null mutable: false name: container_name namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: - group: amqp1 name: idle_timeout deprecated_reason: null deprecated_since: null dest: idle_timeout help: Timeout for inactive connections (in seconds) max: null metavar: null min: null mutable: false name: idle_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: amqp1 name: trace deprecated_reason: null deprecated_since: null dest: trace help: 'Debug: dump AMQP frames to stdout' max: null metavar: null min: null mutable: false name: trace namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: ssl_ca_file deprecated_reason: null deprecated_since: null dest: ssl_ca_file help: CA certificate PEM file used to verify the server's certificate max: null metavar: null min: null mutable: false name: ssl_ca_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: ssl_cert_file deprecated_reason: null deprecated_since: null dest: ssl_cert_file help: Self-identifying certificate PEM file for client authentication max: null metavar: null min: null mutable: false name: ssl_cert_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: ssl_key_file deprecated_reason: null deprecated_since: null dest: ssl_key_file help: Private key PEM file used to sign ssl_cert_file certificate (optional) max: null metavar: null min: null mutable: false name: ssl_key_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: amqp1 name: ssl_key_password deprecated_reason: null deprecated_since: null dest: ssl_key_password help: Password for decrypting ssl_key_file (if encrypted) max: null metavar: null min: null mutable: false name: ssl_key_password namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: - group: amqp1 name: allow_insecure_clients deprecated_reason: Not applicable - not a SSL server deprecated_since: null dest: allow_insecure_clients help: Accept clients using either SSL or plain TCP max: null metavar: null min: null mutable: false name: allow_insecure_clients namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: sasl_mechanisms deprecated_reason: null deprecated_since: null dest: sasl_mechanisms help: Space separated list of acceptable SASL mechanisms max: null metavar: null min: null mutable: false name: sasl_mechanisms namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: sasl_config_dir deprecated_reason: null deprecated_since: null dest: sasl_config_dir help: Path to directory that contains the SASL configuration max: null metavar: null min: null mutable: false name: sasl_config_dir namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: sasl_config_name deprecated_reason: null deprecated_since: null dest: sasl_config_name help: Name of configuration file (without .conf suffix) max: null metavar: null min: null mutable: false name: sasl_config_name namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: username deprecated_reason: null deprecated_since: null dest: username help: User name for message broker authentication max: null metavar: null min: null mutable: false name: username namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: amqp1 name: password deprecated_reason: null deprecated_since: null dest: password help: Password for message broker authentication max: null metavar: null min: null mutable: false name: password namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_retry_interval help: Seconds to pause before attempting to re-connect. max: null metavar: null min: 1 mutable: false name: connection_retry_interval namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_retry_backoff help: Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. max: null metavar: null min: 0 mutable: false name: connection_retry_backoff namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_retry_interval_max help: Maximum limit for connection_retry_interval + connection_retry_backoff max: null metavar: null min: 1 mutable: false name: connection_retry_interval_max namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: link_retry_delay help: Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. max: null metavar: null min: 1 mutable: false name: link_retry_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_reply_retry help: The maximum number of attempts to re-send a reply message which failed due to a recoverable error. max: null metavar: null min: -1 mutable: false name: default_reply_retry namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_reply_timeout help: The deadline for an rpc reply message delivery. max: null metavar: null min: 5 mutable: false name: default_reply_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_send_timeout help: The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. max: null metavar: null min: 5 mutable: false name: default_send_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_notify_timeout help: The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. max: null metavar: null min: 5 mutable: false name: default_notify_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_sender_link_timeout help: The duration to schedule a purge of idle sender links. Detach link after expiry. max: null metavar: null min: 1 mutable: false name: default_sender_link_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: dynamic deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: addressing_mode help: 'Indicates the addressing mode used by the driver. Permitted values: ''legacy'' - use legacy non-routable addressing ''routable'' - use routable addresses ''dynamic'' - use legacy addresses if the message bus does not support routing otherwise use routable addressing' max: null metavar: null min: null mutable: false name: addressing_mode namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: exclusive deprecated_for_removal: false deprecated_opts: - group: amqp1 name: server_request_prefix deprecated_reason: null deprecated_since: null dest: server_request_prefix help: address prefix used when sending to a specific server max: null metavar: null min: null mutable: false name: server_request_prefix namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: broadcast deprecated_for_removal: false deprecated_opts: - group: amqp1 name: broadcast_prefix deprecated_reason: null deprecated_since: null dest: broadcast_prefix help: address prefix used when broadcasting to all servers max: null metavar: null min: null mutable: false name: broadcast_prefix namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: unicast deprecated_for_removal: false deprecated_opts: - group: amqp1 name: group_request_prefix deprecated_reason: null deprecated_since: null dest: group_request_prefix help: address prefix when sending to any server in group max: null metavar: null min: null mutable: false name: group_request_prefix namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack.org/om/rpc deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_address_prefix help: Address prefix for all generated RPC addresses max: null metavar: null min: null mutable: false name: rpc_address_prefix namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack.org/om/notify deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: notify_address_prefix help: Address prefix for all generated Notification addresses max: null metavar: null min: null mutable: false name: notify_address_prefix namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: multicast deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: multicast_address help: Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. max: null metavar: null min: null mutable: false name: multicast_address namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: unicast deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: unicast_address help: Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination. max: null metavar: null min: null mutable: false name: unicast_address namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: anycast deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: anycast_address help: Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers. max: null metavar: null min: null mutable: false name: anycast_address namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_notification_exchange help: 'Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ''notify''' max: null metavar: null min: null mutable: false name: default_notification_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_rpc_exchange help: 'Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ''rpc''' max: null metavar: null min: null mutable: false name: default_rpc_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 200 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: reply_link_credit help: Window size for incoming RPC Reply messages. max: null metavar: null min: 1 mutable: false name: reply_link_credit namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_server_credit help: Window size for incoming RPC Request messages max: null metavar: null min: 1 mutable: false name: rpc_server_credit namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: notify_server_credit help: Window size for incoming Notification messages max: null metavar: null min: 1 mutable: false name: notify_server_credit namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: - rpc-cast - rpc-reply deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pre_settled help: 'Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ''rpc-call'' - send RPC Calls pre-settled ''rpc-reply''- send RPC Replies pre-settled ''rpc-cast'' - Send RPC Casts pre-settled ''notify'' - Send Notifications pre-settled ' max: null metavar: null min: null mutable: false name: pre_settled namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: multi valued oslo_messaging_kafka: help: null opts: - advanced: false choices: null default: localhost deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: kafka_default_host help: Default Kafka broker Host max: null metavar: null min: null mutable: false name: kafka_default_host namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 9092 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: kafka_default_port help: Default Kafka broker Port max: 65535 metavar: null min: 0 mutable: false name: kafka_default_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 1048576 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: kafka_max_fetch_bytes help: Max fetch bytes of Kafka consumer max: null metavar: null min: null mutable: false name: kafka_max_fetch_bytes namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: kafka_consumer_timeout help: Default timeout(s) for Kafka consumers max: null metavar: null min: null mutable: false name: kafka_consumer_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_size help: Pool Size for Kafka Consumers max: null metavar: null min: null mutable: false name: pool_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: conn_pool_min_size help: The pool size limit for connections expiration policy max: null metavar: null min: null mutable: false name: conn_pool_min_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1200 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: conn_pool_ttl help: The time-to-live in sec of idle connections in the pool max: null metavar: null min: null mutable: false name: conn_pool_ttl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: oslo_messaging_consumer deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: consumer_group help: Group id for Kafka consumer. Consumers in one group will coordinate message consumption max: null metavar: null min: null mutable: false name: consumer_group namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: producer_batch_timeout help: Upper bound on the delay for KafkaProducer batching in seconds max: null metavar: null min: null mutable: false name: producer_batch_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 16384 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: producer_batch_size help: Size of batch for the producer async send max: null metavar: null min: null mutable: false name: producer_batch_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value oslo_messaging_notifications: help: null opts: - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: notification_driver deprecated_reason: null deprecated_since: null dest: driver help: The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop max: null metavar: null min: null mutable: false name: driver namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: notification_transport_url deprecated_reason: null deprecated_since: null dest: transport_url help: A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. max: null metavar: null min: null mutable: false name: transport_url namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: - notifications deprecated_for_removal: false deprecated_opts: - group: rpc_notifier2 name: topics - group: DEFAULT name: notification_topics deprecated_reason: null deprecated_since: null dest: topics help: AMQP topic used for OpenStack notifications. max: null metavar: null min: null mutable: false name: topics namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: list value oslo_messaging_rabbit: help: null opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: amqp_durable_queues - group: DEFAULT name: rabbit_durable_queues deprecated_reason: null deprecated_since: null dest: amqp_durable_queues help: Use durable queues in AMQP. max: null metavar: null min: null mutable: false name: amqp_durable_queues namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: amqp_auto_delete deprecated_reason: null deprecated_since: null dest: amqp_auto_delete help: Auto-delete queues in AMQP. max: null metavar: null min: null mutable: false name: amqp_auto_delete namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ssl help: Enable SSL max: null metavar: null min: null mutable: false name: ssl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: oslo_messaging_rabbit name: kombu_ssl_version deprecated_reason: null deprecated_since: null dest: ssl_version help: SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. max: null metavar: null min: null mutable: false name: ssl_version namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: oslo_messaging_rabbit name: kombu_ssl_keyfile deprecated_reason: null deprecated_since: null dest: ssl_key_file help: SSL key file (valid only if SSL enabled). max: null metavar: null min: null mutable: false name: ssl_key_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: oslo_messaging_rabbit name: kombu_ssl_certfile deprecated_reason: null deprecated_since: null dest: ssl_cert_file help: SSL cert file (valid only if SSL enabled). max: null metavar: null min: null mutable: false name: ssl_cert_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '' deprecated_for_removal: false deprecated_opts: - group: oslo_messaging_rabbit name: kombu_ssl_ca_certs deprecated_reason: null deprecated_since: null dest: ssl_ca_file help: SSL certification authority file (valid only if SSL enabled). max: null metavar: null min: null mutable: false name: ssl_ca_file namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: kombu_reconnect_delay deprecated_reason: null deprecated_since: null dest: kombu_reconnect_delay help: How long to wait before reconnecting in response to an AMQP consumer cancel notification. max: null metavar: null min: null mutable: false name: kombu_reconnect_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: kombu_compression help: 'EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.' max: null metavar: null min: null mutable: false name: kombu_compression namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: - group: oslo_messaging_rabbit name: kombu_reconnect_timeout deprecated_reason: null deprecated_since: null dest: kombu_missing_consumer_retry_timeout help: How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout. max: null metavar: null min: null mutable: false name: kombu_missing_consumer_retry_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - round-robin - shuffle default: round-robin deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: kombu_failover_strategy help: Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. max: null metavar: null min: null mutable: false name: kombu_failover_strategy namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: localhost deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_host deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_host help: The RabbitMQ broker address where a single node is used. max: null metavar: null min: null mutable: false name: rabbit_host namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 5672 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_port deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_port help: The RabbitMQ broker port where a single node is used. max: 65535 metavar: null min: 0 mutable: false name: rabbit_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: - $rabbit_host:$rabbit_port deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_hosts deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_hosts help: RabbitMQ HA cluster host:port pairs. max: null metavar: null min: null mutable: false name: rabbit_hosts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: list value - advanced: false choices: null default: guest deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_userid deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_userid help: The RabbitMQ userid. max: null metavar: null min: null mutable: false name: rabbit_userid namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: guest deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_password deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_password help: The RabbitMQ password. max: null metavar: null min: null mutable: false name: rabbit_password namespace: oslo.messaging positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: - PLAIN - AMQPLAIN - RABBIT-CR-DEMO default: AMQPLAIN deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rabbit_login_method deprecated_reason: null deprecated_since: null dest: rabbit_login_method help: The RabbitMQ login method. max: null metavar: null min: null mutable: false name: rabbit_login_method namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: / deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_virtual_host deprecated_reason: Replaced by [DEFAULT]/transport_url deprecated_since: null dest: rabbit_virtual_host help: The RabbitMQ virtual host. max: null metavar: null min: null mutable: false name: rabbit_virtual_host namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rabbit_retry_interval help: How frequently to retry connecting with RabbitMQ. max: null metavar: null min: null mutable: false name: rabbit_retry_interval namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rabbit_retry_backoff deprecated_reason: null deprecated_since: null dest: rabbit_retry_backoff help: How long to backoff for between retries when connecting to RabbitMQ. max: null metavar: null min: null mutable: false name: rabbit_retry_backoff namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rabbit_interval_max help: Maximum interval of RabbitMQ connection retries. Default is 30 seconds. max: null metavar: null min: null mutable: false name: rabbit_interval_max namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: rabbit_max_retries deprecated_reason: null deprecated_since: null dest: rabbit_max_retries help: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). max: null metavar: null min: null mutable: false name: rabbit_max_retries namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rabbit_ha_queues deprecated_reason: null deprecated_since: null dest: rabbit_ha_queues help: 'Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA ''^(?!amq\.).*'' ''{"ha-mode": "all"}'' "' max: null metavar: null min: null mutable: false name: rabbit_ha_queues namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 1800 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rabbit_transient_queues_ttl help: Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues. max: null metavar: null min: 1 mutable: false name: rabbit_transient_queues_ttl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rabbit_qos_prefetch_count help: Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. max: null metavar: null min: null mutable: false name: rabbit_qos_prefetch_count namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: heartbeat_timeout_threshold help: Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL max: null metavar: null min: null mutable: false name: heartbeat_timeout_threshold namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: heartbeat_rate help: How often times during the heartbeat_timeout_threshold we check the heartbeat. max: null metavar: null min: null mutable: false name: heartbeat_rate namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: fake_rabbit deprecated_reason: null deprecated_since: null dest: fake_rabbit help: Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake max: null metavar: null min: null mutable: false name: fake_rabbit namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: channel_max help: Maximum number of channels to allow max: null metavar: null min: null mutable: false name: channel_max namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: frame_max help: The maximum byte size for an AMQP frame max: null metavar: null min: null mutable: false name: frame_max namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: heartbeat_interval help: How often to send heartbeats for consumer's connections max: null metavar: null min: null mutable: false name: heartbeat_interval namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ssl_options help: Arguments passed to ssl.wrap_socket max: null metavar: null min: null mutable: false name: ssl_options namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: dict value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: socket_timeout help: Set socket timeout in seconds for connection's socket max: null metavar: null min: null mutable: false name: socket_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tcp_user_timeout help: Set TCP_USER_TIMEOUT in seconds for connection's socket max: null metavar: null min: null mutable: false name: tcp_user_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host_connection_reconnect_delay help: Set delay for reconnection to some host which has connection error max: null metavar: null min: null mutable: false name: host_connection_reconnect_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: - new - single - read_write default: single deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_factory help: Connection factory implementation max: null metavar: null min: null mutable: false name: connection_factory namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_max_size help: Maximum number of connections to keep queued. max: null metavar: null min: null mutable: false name: pool_max_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_max_overflow help: Maximum number of connections to create above `pool_max_size`. max: null metavar: null min: null mutable: false name: pool_max_overflow namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_timeout help: Default number of seconds to wait for a connections to available max: null metavar: null min: null mutable: false name: pool_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_recycle help: Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. max: null metavar: null min: null mutable: false name: pool_recycle namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_stale help: Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire. max: null metavar: null min: null mutable: false name: pool_stale namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - json - msgpack default: json deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_serializer_type help: Default serialization mechanism for serializing/deserializing outgoing/incoming messages max: null metavar: null min: null mutable: false name: default_serializer_type namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: notification_persistence help: Persist notification messages. max: null metavar: null min: null mutable: false name: notification_persistence namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: ${control_exchange}_notification deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_notification_exchange help: Exchange name for sending notifications max: null metavar: null min: null mutable: false name: default_notification_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: notification_listener_prefetch_count help: Max number of not acknowledged message which RabbitMQ can send to notification listener. max: null metavar: null min: null mutable: false name: notification_listener_prefetch_count namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_notification_retry_attempts help: Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. max: null metavar: null min: null mutable: false name: default_notification_retry_attempts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: notification_retry_delay help: Reconnecting retry delay in case of connectivity problem during sending notification message max: null metavar: null min: null mutable: false name: notification_retry_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_queue_expiration help: Time to live for rpc queues without consumers in seconds. max: null metavar: null min: null mutable: false name: rpc_queue_expiration namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: ${control_exchange}_rpc deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_rpc_exchange help: Exchange name for sending RPC messages max: null metavar: null min: null mutable: false name: default_rpc_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: ${control_exchange}_rpc_reply deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_reply_exchange help: Exchange name for receiving RPC replies max: null metavar: null min: null mutable: false name: rpc_reply_exchange namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_listener_prefetch_count help: Max number of not acknowledged message which RabbitMQ can send to rpc listener. max: null metavar: null min: null mutable: false name: rpc_listener_prefetch_count namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_reply_listener_prefetch_count help: Max number of not acknowledged message which RabbitMQ can send to rpc reply listener. max: null metavar: null min: null mutable: false name: rpc_reply_listener_prefetch_count namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_reply_retry_attempts help: Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout max: null metavar: null min: null mutable: false name: rpc_reply_retry_attempts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_reply_retry_delay help: Reconnecting retry delay in case of connectivity problem during sending reply. max: null metavar: null min: null mutable: false name: rpc_reply_retry_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_rpc_retry_attempts help: Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more than one time max: null metavar: null min: null mutable: false name: default_rpc_retry_attempts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0.25 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_retry_delay help: Reconnecting retry delay in case of connectivity problem during sending RPC message max: null metavar: null min: null mutable: false name: rpc_retry_delay namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: floating point value oslo_messaging_zmq: help: null opts: - advanced: false choices: null default: '*' deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_bind_address deprecated_reason: null deprecated_since: null dest: rpc_zmq_bind_address help: ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. max: null metavar: null min: null mutable: false name: rpc_zmq_bind_address namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: *id001 default: redis deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_matchmaker deprecated_reason: null deprecated_since: null dest: rpc_zmq_matchmaker help: MatchMaker driver. max: null metavar: null min: null mutable: false name: rpc_zmq_matchmaker namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_contexts deprecated_reason: null deprecated_since: null dest: rpc_zmq_contexts help: Number of ZeroMQ contexts, defaults to 1. max: null metavar: null min: null mutable: false name: rpc_zmq_contexts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_topic_backlog deprecated_reason: null deprecated_since: null dest: rpc_zmq_topic_backlog help: Maximum number of ingress messages to locally buffer per topic. Default is unlimited. max: null metavar: null min: null mutable: false name: rpc_zmq_topic_backlog namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: /var/run/openstack deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_ipc_dir deprecated_reason: null deprecated_since: null dest: rpc_zmq_ipc_dir help: Directory for holding IPC sockets. max: null metavar: null min: null mutable: false name: rpc_zmq_ipc_dir namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: openstack.novalocal deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_host deprecated_reason: null deprecated_since: null dest: rpc_zmq_host help: Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. max: null metavar: null min: null mutable: false name: rpc_zmq_host namespace: oslo.messaging positional: false required: false sample_default: localhost secret: false short: null type: string value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_cast_timeout deprecated_reason: null deprecated_since: null dest: zmq_linger help: Number of seconds to wait before all pending messages will be sent after closing a socket. The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Positive values specify an upper bound for the linger period. max: null metavar: null min: null mutable: false name: zmq_linger namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_poll_timeout deprecated_reason: null deprecated_since: null dest: rpc_poll_timeout help: The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. max: null metavar: null min: null mutable: false name: rpc_poll_timeout namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: zmq_target_expire deprecated_reason: null deprecated_since: null dest: zmq_target_expire help: Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). max: null metavar: null min: null mutable: false name: zmq_target_expire namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 180 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: zmq_target_update deprecated_reason: null deprecated_since: null dest: zmq_target_update help: Update period in seconds of a name service record about existing target. max: null metavar: null min: null mutable: false name: zmq_target_update namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_pub_sub deprecated_reason: null deprecated_since: null dest: use_pub_sub help: Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. max: null metavar: null min: null mutable: false name: use_pub_sub namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: use_router_proxy deprecated_reason: null deprecated_since: null dest: use_router_proxy help: Use ROUTER remote proxy. max: null metavar: null min: null mutable: false name: use_router_proxy namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_dynamic_connections help: This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise). max: null metavar: null min: null mutable: false name: use_dynamic_connections namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_failover_connections help: How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode. max: null metavar: null min: null mutable: false name: zmq_failover_connections namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 49153 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_min_port deprecated_reason: null deprecated_since: null dest: rpc_zmq_min_port help: Minimal port number for random ports range. max: 65535 metavar: null min: 0 mutable: false name: rpc_zmq_min_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 65536 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_max_port deprecated_reason: null deprecated_since: null dest: rpc_zmq_max_port help: Maximal port number for random ports range. max: 65536 metavar: null min: 1 mutable: false name: rpc_zmq_max_port namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_bind_port_retries deprecated_reason: null deprecated_since: null dest: rpc_zmq_bind_port_retries help: Number of retries to find free port number before fail with ZMQBindError. max: null metavar: null min: null mutable: false name: rpc_zmq_bind_port_retries namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: *id002 default: json deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: rpc_zmq_serialization deprecated_reason: null deprecated_since: null dest: rpc_zmq_serialization help: Default serialization mechanism for serializing/deserializing outgoing/incoming messages max: null metavar: null min: null mutable: false name: rpc_zmq_serialization namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_immediate help: This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. max: null metavar: null min: null mutable: false name: zmq_immediate namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive help: Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_idle help: The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_idle namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_cnt help: The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_cnt namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: zmq_tcp_keepalive_intvl help: The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default. max: null metavar: null min: null mutable: false name: zmq_tcp_keepalive_intvl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_thread_pool_size help: Maximum number of (green) threads to work concurrently. max: null metavar: null min: null mutable: false name: rpc_thread_pool_size namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_message_ttl help: Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server. max: null metavar: null min: null mutable: false name: rpc_message_ttl namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_use_acks help: Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB. max: null metavar: null min: null mutable: false name: rpc_use_acks namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 15 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_ack_timeout_base help: Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier. max: null metavar: null min: null mutable: false name: rpc_ack_timeout_base namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 2 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_ack_timeout_multiplier help: Number to multiply base ack timeout by after each retry attempt. max: null metavar: null min: null mutable: false name: rpc_ack_timeout_multiplier namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: rpc_retry_attempts help: 'Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.' max: null metavar: null min: null mutable: false name: rpc_retry_attempts namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: subscribe_on help: List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker. max: null metavar: null min: null mutable: false name: subscribe_on namespace: oslo.messaging positional: false required: false sample_default: null secret: false short: null type: list value oslo_middleware: help: null opts: - advanced: false choices: null default: 114688 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: osapi_max_request_body_size - group: DEFAULT name: max_request_body_size deprecated_reason: null deprecated_since: null dest: max_request_body_size help: The maximum body size for each request, in bytes. max: null metavar: null min: null mutable: false name: max_request_body_size namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: X-Forwarded-Proto deprecated_for_removal: true deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: secure_proxy_ssl_header help: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy. max: null metavar: null min: null mutable: false name: secure_proxy_ssl_header namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enable_proxy_headers_parsing help: Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. max: null metavar: null min: null mutable: false name: enable_proxy_headers_parsing namespace: oslo.middleware positional: false required: false sample_default: null secret: false short: null type: boolean value oslo_policy: help: null opts: - advanced: false choices: null default: policy.json deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: policy_file deprecated_reason: null deprecated_since: null dest: policy_file help: The file that defines policies. max: null metavar: null min: null mutable: false name: policy_file namespace: oslo.policy positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: default deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: policy_default_rule deprecated_reason: null deprecated_since: null dest: policy_default_rule help: Default rule. Enforced when a requested rule is not found. max: null metavar: null min: null mutable: false name: policy_default_rule namespace: oslo.policy positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: - policy.d deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: policy_dirs deprecated_reason: null deprecated_since: null dest: policy_dirs help: Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored. max: null metavar: null min: null mutable: false name: policy_dirs namespace: oslo.policy positional: false required: false sample_default: null secret: false short: null type: multi valued pci: help: null opts: - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: pci_alias deprecated_reason: null deprecated_since: null dest: alias help: "\nAn alias for a PCI passthrough device requirement.\n\nThis allows users\ \ to specify the alias in the extra_spec for a flavor, without\nneeding to\ \ repeat all the PCI property requirements.\n\nPossible Values:\n\n* A list\ \ of JSON values which describe the aliases. For example:\n\n alias = {\n\ \ \"name\": \"QuickAssist\",\n \"product_id\": \"0443\",\n \ \ \"vendor_id\": \"8086\",\n \"device_type\": \"type-PCI\"\n }\n\n\ \ defines an alias for the Intel QuickAssist card. (multi valued). Valid\ \ key\n values are :\n\n * \"name\": Name of the PCI alias.\n * \"product_id\"\ : Product ID of the device in hexadecimal.\n * \"vendor_id\": Vendor ID of\ \ the device in hexadecimal.\n * \"device_type\": Type of PCI device. Valid\ \ values are: \"type-PCI\",\n \"type-PF\" and \"type-VF\".\n" max: null metavar: null min: null mutable: false name: alias namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued - advanced: false choices: null default: [] deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: pci_passthrough_whitelist deprecated_reason: null deprecated_since: null dest: passthrough_whitelist help: "\nWhite list of PCI devices available to VMs.\n\nPossible values:\n\n\ * A JSON dictionary which describe a whitelisted PCI device. It should take\n\ \ the following format:\n\n [\"vendor_id\": \"\",] [\"product_id\"\ : \"\",]\n [\"address\": \"[[[[]:]]:][][.[]]\"\ \ |\n \"devname\": \"\",]\n {\"\": \"\",}\n\n\ \ Where '[' indicates zero or one occurrences, '{' indicates zero or multiple\n\ \ occurrences, and '|' mutually exclusive options. Note that any missing\n\ \ fields are automatically wildcarded.\n\n Valid key values are :\n\n *\ \ \"vendor_id\": Vendor ID of the device in hexadecimal.\n * \"product_id\"\ : Product ID of the device in hexadecimal.\n * \"address\": PCI address of\ \ the device.\n * \"devname\": Device name of the device (for e.g. interface\ \ name). Not all\n PCI devices have a name.\n * \"\": Additional\ \ and used for matching PCI devices.\n Supported :\ \ \"physical_network\".\n\n The address key supports traditional glob style\ \ and regular expression\n syntax. Valid examples are:\n\n passthrough_whitelist\ \ = {\"devname\":\"eth0\",\n \"physical_network\"\ :\"physnet\"}\n passthrough_whitelist = {\"address\":\"*:0a:00.*\"}\n \ \ passthrough_whitelist = {\"address\":\":0a:00.\",\n \ \ \"physical_network\":\"physnet1\"}\n passthrough_whitelist\ \ = {\"vendor_id\":\"1137\",\n \"product_id\"\ :\"0071\"}\n passthrough_whitelist = {\"vendor_id\":\"1137\",\n \ \ \"product_id\":\"0071\",\n \ \ \"address\": \"0000:0a:00.1\",\n \"physical_network\"\ :\"physnet1\"}\n passthrough_whitelist = {\"address\":{\"domain\": \".*\"\ ,\n \"bus\": \"02\", \"slot\": \"01\"\ ,\n \"function\": \"[2-7]\"},\n \ \ \"physical_network\":\"physnet1\"}\n passthrough_whitelist\ \ = {\"address\":{\"domain\": \".*\",\n \ \ \"bus\": \"02\", \"slot\": \"0[1-2]\",\n \ \ \"function\": \".*\"},\n \"physical_network\"\ :\"physnet1\"}\n\n The following are invalid, as they specify mutually exclusive\ \ options:\n\n passthrough_whitelist = {\"devname\":\"eth0\",\n \ \ \"physical_network\":\"physnet\",\n \ \ \"address\":\"*:0a:00.*\"}\n\n* A JSON list of JSON dictionaries\ \ corresponding to the above format. For\n example:\n\n passthrough_whitelist\ \ = [{\"product_id\":\"0001\", \"vendor_id\":\"8086\"},\n \ \ {\"product_id\":\"0002\", \"vendor_id\":\"8086\"}]\n" max: null metavar: null min: null mutable: false name: passthrough_whitelist namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: multi valued placement: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: os_region_name help: ' Region name of this node. This is used when picking the URL in the service catalog. Possible values: * Any string representing region name ' max: null metavar: null min: null mutable: false name: os_region_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: os_interface help: ' Endpoint interface for this node. This is used when picking the URL in the service catalog. ' max: null metavar: null min: null mutable: false name: os_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: PEM encoded Certificate Authority to use when verifying HTTPs connections. max: null metavar: null min: null mutable: false name: cafile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: PEM encoded client certificate cert file max: null metavar: null min: null mutable: false name: certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: PEM encoded client certificate key file max: null metavar: null min: null mutable: false name: keyfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout help: Timeout value for http requests max: null metavar: null min: null mutable: false name: timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: placement name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_url help: Authentication URL max: null metavar: null min: null mutable: false name: auth-url namespace: nova.conf positional: false required: true sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID to scope to max: null metavar: null min: null mutable: false name: domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name to scope to max: null metavar: null min: null mutable: false name: domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID to scope to max: null metavar: null min: null mutable: false name: project-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name to scope to max: null metavar: null min: null mutable: false name: project-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Domain ID containing project max: null metavar: null min: null mutable: false name: project-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Domain name containing project max: null metavar: null min: null mutable: false name: project-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID max: null metavar: null min: null mutable: false name: trust-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_id help: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_name help: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID max: null metavar: null min: null mutable: false name: user-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: placement name: user_name deprecated_reason: null deprecated_since: null dest: username help: Username max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain id max: null metavar: null min: null mutable: false name: user-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name max: null metavar: null min: null mutable: false name: user-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: User's password max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_id help: Tenant ID max: null metavar: null min: null mutable: false name: tenant-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_name help: Tenant Name max: null metavar: null min: null mutable: false name: tenant-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value placement_database: help: ' The *Placement API Database* is a separate database which is used for the new placement-api service. In Ocata release (14.0.0) this database is optional: if connection option is not set, api database will be used instead. However, this is not recommended, as it implies a potentially lengthy data migration in the future. Operators are advised to use a separate database for Placement API from the start. ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection help: The SQLAlchemy connection string to use to connect to the database. max: null metavar: null min: null mutable: false name: connection namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sqlite_synchronous help: If True, SQLite uses synchronous mode. max: null metavar: null min: null mutable: false name: sqlite_synchronous namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: slave_connection help: The SQLAlchemy connection string to use to connect to the slave database. max: null metavar: null min: null mutable: false name: slave_connection namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: TRADITIONAL deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: mysql_sql_mode help: 'The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=' max: null metavar: null min: null mutable: false name: mysql_sql_mode namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3600 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: idle_timeout help: Timeout before idle SQL connections are reaped. max: null metavar: null min: null mutable: false name: idle_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_pool_size help: Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit. max: null metavar: null min: null mutable: false name: max_pool_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_retries help: Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. max: null metavar: null min: null mutable: false name: max_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: retry_interval help: Interval between retries of opening a SQL connection. max: null metavar: null min: null mutable: false name: retry_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_overflow help: If set, use this value for max_overflow with SQLAlchemy. max: null metavar: null min: null mutable: false name: max_overflow namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_debug help: 'Verbosity of SQL debugging information: 0=None, 100=Everything.' max: null metavar: null min: null mutable: false name: connection_debug namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_trace help: Add Python stack traces to SQL as comment strings. max: null metavar: null min: null mutable: false name: connection_trace namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pool_timeout help: If set, use this value for pool_timeout with SQLAlchemy. max: null metavar: null min: null mutable: false name: pool_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value quota: help: ' Quota options allow to manage quotas in openstack deployment. ' opts: - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_instances deprecated_reason: null deprecated_since: null dest: instances help: ' The number of instances allowed per project. Possible Values * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: instances namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 20 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_cores deprecated_reason: null deprecated_since: null dest: cores help: ' The number of instance cores or vCPUs allowed per project. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: cores namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 51200 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_ram deprecated_reason: null deprecated_since: null dest: ram help: ' The number of megabytes of instance RAM allowed per project. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: ram namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: quota_floating_ips deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: floating_ips help: ' The number of floating IPs allowed per project. Floating IPs are not allocated to instances by default. Users need to select them from the pool configured by the OpenStack administrator to attach to their instances. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: floating_ips namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: quota_fixed_ips deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: fixed_ips help: ' The number of fixed IPs allowed per project. Unlike floating IPs, fixed IPs are allocated dynamically by the network component when instances boot up. This quota value should be at least the number of instances allowed Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: fixed_ips namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 128 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_metadata_items deprecated_reason: null deprecated_since: null dest: metadata_items help: ' The number of metadata items allowed per instance. Users can associate metadata with an instance during instance creation. This metadata takes the form of key-value pairs. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: metadata_items namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_injected_files deprecated_reason: null deprecated_since: null dest: injected_files help: ' The number of injected files allowed. File injection allows 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 are not accepted. During file injection, any existing files that match specified files are renamed to include ``.bak`` extension appended with a timestamp. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: injected_files namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10240 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_injected_file_content_bytes deprecated_reason: null deprecated_since: null dest: injected_file_content_bytes help: ' The number of bytes allowed per injected file. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: injected_file_content_bytes namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 255 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_injected_file_path_length deprecated_reason: null deprecated_since: null dest: injected_file_path_length help: ' The maximum allowed injected file path length. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: injected_file_path_length namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: quota_security_groups deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: security_groups help: ' The number of security groups per project. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: security_groups namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 20 deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: quota_security_group_rules deprecated_reason: ' nova-network is deprecated, as are any related configuration options. ' deprecated_since: 15.0.0 dest: security_group_rules help: ' 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: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: security_group_rules namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_key_pairs deprecated_reason: null deprecated_since: null dest: key_pairs help: ' 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: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: key_pairs namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_server_groups deprecated_reason: null deprecated_since: null dest: server_groups help: ' The maxiumum number of server groups per project. Server groups are used to control the affinity and anti-affinity scheduling policy for a group of servers or instances. Reducing the quota will not affect any existing group, but new servers will not be allowed into groups that have become over quota. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: server_groups namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: quota_server_group_members deprecated_reason: null deprecated_since: null dest: server_group_members help: ' The maximum number of servers per server group. Possible values: * A positive integer or 0. * -1 to disable the quota. ' max: null metavar: null min: -1 mutable: false name: server_group_members namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 86400 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: reservation_expire deprecated_reason: null deprecated_since: null dest: reservation_expire help: ' The number of seconds until a reservation expires. This quota represents the time period for invalidating quota reservations. ' max: null metavar: null min: null mutable: false name: reservation_expire namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: until_refresh deprecated_reason: null deprecated_since: null dest: until_refresh help: ' The count of reservations until usage is refreshed. 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. ' max: null metavar: null min: 0 mutable: false name: until_refresh namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: max_age deprecated_reason: null deprecated_since: null dest: max_age help: ' 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. ' max: null metavar: null min: 0 mutable: false name: max_age namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: nova.quota.DbQuotaDriver deprecated_for_removal: true deprecated_opts: - group: DEFAULT name: quota_driver deprecated_reason: null deprecated_since: 14.0.0 dest: driver help: "\nThe quota enforcer driver.\n\nProvides abstraction for quota checks.\ \ Users can configure a specific\ndriver to use for quota checks.\n\nPossible\ \ values:\n\n* nova.quota.DbQuotaDriver (default) or any string representing\ \ fully\n qualified class name.\n" max: null metavar: null min: null mutable: false name: driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value rdp: help: ' Options under this group enable and configure Remote Desktop Protocol ( RDP) related features. This group is only relevant to Hyper-V users. ' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: ' 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. ' max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: http://127.0.0.1:6083/ deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: html5_proxy_base_url help: "\nThe URL an end user would use to connect to the RDP HTML5 console proxy.\n\ The console proxy service is called with this token-embedded URL and\nestablishes\ \ the connection to the proper instance.\n\nAn RDP HTML5 console proxy service\ \ will need to be configured to listen on the\naddress configured here. Typically\ \ the console proxy service would be run on a\ncontroller node. The localhost\ \ address used as default would only work in a\nsingle node environment i.e.\ \ devstack.\n\nAn RDP HTML5 proxy allows a user to access via the web the\ \ text or graphical\nconsole of any Windows server or workstation using RDP.\ \ RDP HTML5 console\nproxy services include FreeRDP, wsgate.\nSee https://github.com/FreeRDP/FreeRDP-WebConnect\n\ \nPossible values:\n\n* ://:/\n\n The scheme\ \ must be identical to the scheme configured for the RDP HTML5\n console\ \ proxy service.\n\n The IP address must be identical to the address on which\ \ the RDP HTML5\n console proxy service is listening.\n\n The port must\ \ be identical to the port on which the RDP HTML5 console proxy\n service\ \ is listening.\n\nRelated options:\n\n* ``rdp.enabled``: Must be set to ``True``\ \ for ``html5_proxy_base_url`` to be\n effective.\n" max: null metavar: null min: null mutable: false name: html5_proxy_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value remote_debug: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host help: "\nDebug host (IP or name) to connect to. This command line parameter\ \ is used when\nyou want to connect to a nova service via a debugger running\ \ on a different\nhost.\n\nNote that using the remote debug option changes\ \ how Nova uses the eventlet\nlibrary to support async IO. This could result\ \ in failures that do not occur\nunder normal operation. Use at your own risk.\n\ \nPossible Values:\n\n * IP address of a remote host as a command line parameter\n\ \ to a nova service. For Example:\n\n /usr/local/bin/nova-compute --config-file\ \ /etc/nova/nova.conf\n --remote_debug-host \n" max: null metavar: null min: null mutable: false name: host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: port help: "\nDebug port to connect to. This command line parameter allows you to\ \ specify\nthe port you want to use to connect to a nova service via a debugger\ \ running\non different host.\n\nNote that using the remote debug option changes\ \ how Nova uses the eventlet\nlibrary to support async IO. This could result\ \ in failures that do not occur\nunder normal operation. Use at your own risk.\n\ \nPossible Values:\n\n * Port number you want to use as a command line parameter\n\ \ to a nova service. For Example:\n\n /usr/local/bin/nova-compute --config-file\ \ /etc/nova/nova.conf\n --remote_debug-host \n --remote_debug-port it's listening on>.\n" max: 65535 metavar: null min: 0 mutable: false name: port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value scheduler: help: null opts: - advanced: false choices: - host_manager - ironic_host_manager default: host_manager deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_host_manager deprecated_reason: null deprecated_since: null dest: host_manager help: ' The scheduler host manager to use. The host manager manages the in-memory picture of the hosts that the scheduler uses. The options values are chosen from the entry points under the namespace ''nova.scheduler.host_manager'' in ''setup.cfg''. ' max: null metavar: null min: null mutable: false name: host_manager namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: - filter_scheduler - caching_scheduler - chance_scheduler - fake_scheduler default: filter_scheduler deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_driver deprecated_reason: null deprecated_since: null dest: driver help: "\nThe class of the driver used by the scheduler.\n\nThe options are chosen\ \ from the entry points under the namespace\n'nova.scheduler.driver' in 'setup.cfg'.\n\ \nPossible values:\n\n* A string, where the string corresponds to the class\ \ name of a scheduler\n driver. There are a number of options available:\n\ ** 'caching_scheduler', which aggressively caches the system state for better\n\ \ individual scheduler performance at the risk of more retries when running\n\ \ multiple schedulers\n** 'chance_scheduler', which simply picks a host\ \ at random\n** 'fake_scheduler', which is used for testing\n** A custom scheduler\ \ driver. In this case, you will be responsible for\n creating and maintaining\ \ the entry point in your 'setup.cfg' file\n" max: null metavar: null min: null mutable: false name: driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_driver_task_period deprecated_reason: null deprecated_since: null dest: periodic_task_interval help: "\nPeriodic task interval.\n\nThis value controls how often (in seconds)\ \ to run periodic tasks in the\nscheduler. The specific tasks that are run\ \ for each period are determined by\nthe particular scheduler being used.\n\ \nIf this is larger than the nova-service 'service_down_time' setting, Nova\ \ may\nreport the scheduler service as down. This is because the scheduler\ \ driver is\nresponsible for sending a heartbeat and it will only do that\ \ as often as this\noption allows. As each scheduler can work a little differently\ \ than the others,\nbe sure to test this with your selected scheduler.\n\n\ Possible values:\n\n* An integer, where the integer corresponds to periodic\ \ task interval in\n seconds. 0 uses the default interval (60 seconds). A\ \ negative value disables\n periodic tasks.\n\nRelated options:\n\n* ``nova-service\ \ service_down_time``\n" max: null metavar: null min: null mutable: false name: periodic_task_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 3 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: scheduler_max_attempts deprecated_reason: null deprecated_since: null dest: max_attempts help: "\nMaximum number of schedule attempts for a chosen host.\n\nThis is the\ \ maximum number of attempts that will be made to schedule an\ninstance before\ \ it is assumed that the failures aren't due to normal occasional\nrace conflicts,\ \ but rather some other problem. When this is reached a\nMaxRetriesExceeded\ \ exception is raised, and the instance is set to an error\nstate.\n\nPossible\ \ values:\n\n* A positive integer, where the integer corresponds to the max\ \ number of\n attempts that can be made when scheduling an instance.\n \ \ " max: null metavar: null min: 1 mutable: false name: max_attempts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: -1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: discover_hosts_in_cells_interval help: ' Periodic task interval. This value controls how often (in seconds) the scheduler should attempt to discover new hosts that have been added to cells. If negative (the default), no automatic discovery will occur. Small deployments may want this periodic task enabled, as surveying the cells for new hosts is likely to be lightweight enough to not cause undue burdon to the scheduler. However, larger clouds (and those that are not adding hosts regularly) will likely want to disable this automatic behavior and instead use the `nova-manage cell_v2 discover_hosts` command when hosts have been added to a cell. ' max: null metavar: null min: -1 mutable: false name: discover_hosts_in_cells_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value serial_console: help: ' The serial console feature allows you to connect to a guest in case a graphical console like VNC, RDP or SPICE is not available. This is only currently supported for the libvirt, Ironic and hyper-v drivers.' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: ' Enable the serial console feature. In order to use this feature, the service ``nova-serialproxy`` needs to run. This service is typically executed on the controller node. ' max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10000:20000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: port_range help: "\nA range of TCP ports a guest can use for its backend.\n\nEach instance\ \ which gets created will use one port out of this range. If the\nrange is\ \ not big enough to provide another port for an new instance, this\ninstance\ \ won't get launched.\n\nPossible values:\n\n* Each string which passes the\ \ regex ``\\d+:\\d+`` For example ``10000:20000``.\n Be sure that the first\ \ port number is lower than the second port number\n and that both are in\ \ range from 0 to 65535.\n" max: null metavar: null min: null mutable: false name: port_range namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: ws://127.0.0.1:6083/ deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: base_url help: "\nThe URL an end user would use to connect to the ``nova-serialproxy``\ \ service.\n\nThe ``nova-serialproxy`` service is called with this token enriched\ \ URL\nand establishes the connection to the proper instance.\n\nRelated options:\n\ \n* The IP address must be identical to the address to which the\n ``nova-serialproxy``\ \ service is listening (see option ``serialproxy_host``\n in this section).\n\ * The port must be the same as in the option ``serialproxy_port`` of this\n\ \ section.\n* If you choose to use a secured websocket connection, then start\ \ this option\n with ``wss://`` instead of the unsecured ``ws://``. The options\ \ ``cert``\n and ``key`` in the ``[DEFAULT]`` section have to be set for\ \ that.\n" max: null metavar: null min: null mutable: false name: base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: proxyclient_address help: ' The IP address to which proxy clients (like ``nova-serialproxy``) should connect to get the serial console of an instance. This is typically the IP address of the host of a ``nova-compute`` service. ' max: null metavar: null min: null mutable: false name: proxyclient_address namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: serialproxy_host help: "\nThe IP address which is used by the ``nova-serialproxy`` service to\ \ listen\nfor incoming requests.\n\nThe ``nova-serialproxy`` service listens\ \ on this IP address for incoming\nconnection requests to instances which\ \ expose serial console.\n\nRelated options:\n\n* Ensure that this is the\ \ same IP address which is defined in the option\n ``base_url`` of this section\ \ or use ``0.0.0.0`` to listen on all addresses.\n" max: null metavar: null min: null mutable: false name: serialproxy_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 6083 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: serialproxy_port help: "\nThe port number which is used by the ``nova-serialproxy`` service to\ \ listen\nfor incoming requests.\n\nThe ``nova-serialproxy`` service listens\ \ on this port number for incoming\nconnection requests to instances which\ \ expose serial console.\n\nRelated options:\n\n* Ensure that this is the\ \ same port number which is defined in the option\n ``base_url`` of this\ \ section.\n" max: 65535 metavar: null min: 0 mutable: false name: serialproxy_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value service_user: help: ' Configuration options for service to service authentication using a service token. These options allow to send a service token along with the user''s token when contacting external REST APIs. ' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: send_service_user_token help: ' When True, if sending a user token to an REST API, also send a service token. Nova often reuses the user token provided to the nova-api to talk to other REST APIs, such as Cinder and Neutron. It is possible that while the user token was valid when the request was made to Nova, the token may expire before it reaches the other service. To avoid any failures, and to make it clear it is Nova calling the service on the users behalf, we include a server token along with the user token. Should the user''s token have expired, a valid service token ensures the REST API request will still be accepted by the keystone middleware. This feature is currently experimental, and as such is turned off by default while full testing and performance tuning of this feature is completed. ' max: null metavar: null min: null mutable: false name: send_service_user_token namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: PEM encoded Certificate Authority to use when verifying HTTPs connections. max: null metavar: null min: null mutable: false name: cafile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: PEM encoded client certificate cert file max: null metavar: null min: null mutable: false name: certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: PEM encoded client certificate key file max: null metavar: null min: null mutable: false name: keyfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout help: Timeout value for http requests max: null metavar: null min: null mutable: false name: timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: service_user name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_url help: Authentication URL max: null metavar: null min: null mutable: false name: auth-url namespace: nova.conf positional: false required: true sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID to scope to max: null metavar: null min: null mutable: false name: domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name to scope to max: null metavar: null min: null mutable: false name: domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID to scope to max: null metavar: null min: null mutable: false name: project-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name to scope to max: null metavar: null min: null mutable: false name: project-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Domain ID containing project max: null metavar: null min: null mutable: false name: project-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Domain name containing project max: null metavar: null min: null mutable: false name: project-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID max: null metavar: null min: null mutable: false name: trust-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_id help: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_name help: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID max: null metavar: null min: null mutable: false name: user-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: service_user name: user_name deprecated_reason: null deprecated_since: null dest: username help: Username max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain id max: null metavar: null min: null mutable: false name: user-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name max: null metavar: null min: null mutable: false name: user-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: User's password max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_id help: Tenant ID max: null metavar: null min: null mutable: false name: tenant-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_name help: Tenant Name max: null metavar: null min: null mutable: false name: tenant-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value spice: help: ' SPICE console feature allows you to connect to a guest virtual machine. SPICE is a replacement for fairly limited VNC protocol. Following requirements must be met in order to use SPICE: * Virtualization driver must be libvirt * spice.enabled set to True * vnc.enabled set to False * update html5proxy_base_url * update server_proxyclient_address ' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: enabled help: "\nEnable SPICE related features.\n\nRelated options:\n\n* VNC must be\ \ explicitly disabled to get access to the SPICE console. Set the\n enabled\ \ option to False in the [vnc] section to disable the VNC console.\n" max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: agent_enabled help: "\nEnable the SPICE guest agent support on the instances.\n\nThe Spice\ \ agent works with the Spice protocol to offer a better guest console\nexperience.\ \ However, the Spice console can still be used without the Spice\nAgent. With\ \ the Spice agent installed the following features are enabled:\n\n* Copy\ \ & Paste of text and images between the guest and client machine\n* Automatic\ \ adjustment of resolution when the client screen changes - e.g.\n if you\ \ make the Spice console full screen the guest resolution will adjust to\n\ \ match it rather than letterboxing.\n* Better mouse integration - The mouse\ \ can be captured and released without\n needing to click inside the console\ \ or press keys to release it. The\n performance of mouse movement is also\ \ improved.\n" max: null metavar: null min: null mutable: false name: agent_enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: http://127.0.0.1:6082/spice_auto.html deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: html5proxy_base_url help: "\nLocation of the SPICE HTML5 console proxy.\n\nEnd user would use this\ \ URL to connect to the `nova-spicehtml5proxy``\nservice. This service will\ \ forward request to the console of an instance.\n\nIn order to use SPICE\ \ console, the service ``nova-spicehtml5proxy`` should be\nrunning. This service\ \ is typically launched on the controller node.\n\nPossible values:\n\n* Must\ \ be a valid URL of the form: ``http://host:port/spice_auto.html``\n where\ \ host is the node running ``nova-spicehtml5proxy`` and the port is\n typically\ \ 6082. Consider not using default value as it is not well defined\n for\ \ any real deployment.\n\nRelated options:\n\n* This option depends on ``html5proxy_host``\ \ and ``html5proxy_port`` options.\n The access URL returned by the compute\ \ node must have the host\n and port where the ``nova-spicehtml5proxy`` service\ \ is listening.\n" max: null metavar: null min: null mutable: false name: html5proxy_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: server_listen help: ' The address where the SPICE server running on the instances should listen. Typically, the ``nova-spicehtml5proxy`` proxy client runs on the controller node and connects over the private network to this address on the compute node(s). Possible values: * IP address to listen on. ' max: null metavar: null min: null mutable: false name: server_listen namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: server_proxyclient_address help: "\nThe address used by ``nova-spicehtml5proxy`` client to connect to instance\n\ console.\n\nTypically, the ``nova-spicehtml5proxy`` proxy client runs on the\n\ controller node and connects over the private network to this address on the\n\ compute node(s).\n\nPossible values:\n\n* Any valid IP address on the compute\ \ node.\n\nRelated options:\n\n* This option depends on the ``server_listen``\ \ option.\n The proxy client must be able to access the address specified\ \ in\n ``server_listen`` using the value of this option.\n" max: null metavar: null min: null mutable: false name: server_proxyclient_address namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: en-us deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keymap help: "\nA keyboard layout which is supported by the underlying hypervisor on\ \ this\nnode.\n\nPossible values:\n* This is usually an 'IETF language tag'\ \ (default is 'en-us'). If you\n use QEMU as hypervisor, you should find\ \ the list of supported keyboard\n layouts at /usr/share/qemu/keymaps.\n" max: null metavar: null min: null mutable: false name: keymap namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: html5proxy_host help: "\nIP address or a hostname on which the ``nova-spicehtml5proxy`` service\n\ listens for incoming requests.\n\nRelated options:\n\n* This option depends\ \ on the ``html5proxy_base_url`` option.\n The ``nova-spicehtml5proxy`` service\ \ must be listening on a host that is\n accessible from the HTML5 client.\n" max: null metavar: null min: null mutable: false name: html5proxy_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 6082 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: html5proxy_port help: "\nPort on which the ``nova-spicehtml5proxy`` service listens for incoming\n\ requests.\n\nRelated options:\n\n* This option depends on the ``html5proxy_base_url``\ \ option.\n The ``nova-spicehtml5proxy`` service must be listening on a port\ \ that is\n accessible from the HTML5 client.\n" max: 65535 metavar: null min: 0 mutable: false name: html5proxy_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value ssl: help: null opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_ca_file deprecated_reason: null deprecated_since: null dest: ca_file help: CA certificate file to use to verify connecting clients. max: null metavar: null min: null mutable: false name: ca_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_cert_file deprecated_reason: null deprecated_since: null dest: cert_file help: Certificate file to use when starting the server securely. max: null metavar: null min: null mutable: false name: cert_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_key_file deprecated_reason: null deprecated_since: null dest: key_file help: Private key file to use when starting the server securely. max: null metavar: null min: null mutable: false name: key_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: version help: SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. max: null metavar: null min: null mutable: false name: version namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ciphers help: Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format. max: null metavar: null min: null mutable: false name: ciphers namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value trusted_computing: help: ' Configuration options for enabling Trusted Platform Module. ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_server help: "\nThe host to use as the attestation server.\n\nCloud computing pools\ \ can involve thousands of compute nodes located at\ndifferent geographical\ \ locations, making it difficult for cloud providers to\nidentify a node's\ \ trustworthiness. When using the Trusted filter, users can\nrequest that\ \ their VMs only be placed on nodes that have been verified by the\nattestation\ \ server specified in this option.\n\nThis option is only used by the FilterScheduler\ \ and its subclasses; if you use\na different scheduler, this option has no\ \ effect. Also note that this setting\nonly affects scheduling if the 'TrustedFilter'\ \ filter is enabled.\n\nPossible values:\n\n* A string representing the host\ \ name or IP address of the attestation server,\n or an empty string.\n\n\ Related options:\n\n* attestation_server_ca_file\n* attestation_port\n* attestation_api_url\n\ * attestation_auth_blob\n* attestation_auth_timeout\n* attestation_insecure_ssl\n" max: null metavar: null min: null mutable: false name: attestation_server namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_server_ca_file help: "\nThe absolute path to the certificate to use for authentication when\ \ connecting\nto the attestation server. See the `attestation_server` help\ \ text for more\ninformation about host verification.\n\nThis option is only\ \ used by the FilterScheduler and its subclasses; if you use\na different\ \ scheduler, this option has no effect. Also note that this setting\nonly\ \ affects scheduling if the 'TrustedFilter' filter is enabled.\n\nPossible\ \ values:\n\n* A string representing the path to the authentication certificate\ \ for the\n attestation server, or an empty string.\n\nRelated options:\n\ \n* attestation_server\n* attestation_port\n* attestation_api_url\n* attestation_auth_blob\n\ * attestation_auth_timeout\n* attestation_insecure_ssl\n" max: null metavar: null min: null mutable: false name: attestation_server_ca_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 8443 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_port help: ' The port to use when connecting to the attestation server. See the `attestation_server` help text for more information about host verification. 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 ' max: 65535 metavar: null min: 0 mutable: false name: attestation_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: /OpenAttestationWebServices/V1.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_api_url help: ' 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. Possible values: * A valid URL string of the attestation server, or an empty string. Related options: * attestation_server * attestation_server_ca_file * attestation_port * attestation_auth_blob * attestation_auth_timeout * attestation_insecure_ssl ' max: null metavar: null min: null mutable: false name: attestation_api_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_auth_blob help: "\nAttestation servers require a specific blob that is used to authenticate.\ \ The\ncontent and format of the blob are determined by the particular attestation\n\ server being used. There is no default value; you must supply the value as\n\ specified by your attestation service. See the `attestation_server` help text\n\ for more information about host verification.\n\nThis option is only used\ \ by the FilterScheduler and its subclasses; if you use\na different scheduler,\ \ this option has no effect. Also note that this setting\nonly affects scheduling\ \ if the 'TrustedFilter' filter is enabled.\n\nPossible values:\n\n* A string\ \ containing the specific blob required by the attestation server, or\n an\ \ empty string.\n\nRelated options:\n\n* attestation_server\n* attestation_server_ca_file\n\ * attestation_port\n* attestation_api_url\n* attestation_auth_timeout\n* attestation_insecure_ssl\n" max: null metavar: null min: null mutable: false name: attestation_auth_blob namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_auth_timeout help: "\nThis value controls how long a successful attestation is cached. Once\ \ this\nperiod has elapsed, a new attestation request will be made. See the\n\ `attestation_server` help text for more information about host verification.\n\ \nThis option is only used by the FilterScheduler and its subclasses; if you\ \ use\na different scheduler, this option has no effect. Also note that this\ \ setting\nonly affects scheduling if the 'TrustedFilter' filter is enabled.\n\ \nPossible values:\n\n* A integer value, corresponding to the timeout interval\ \ for attestations in\n seconds. Any integer is valid, although setting this\ \ to zero or negative\n values can greatly impact performance when using\ \ an attestation service.\n\nRelated options:\n\n* attestation_server\n* attestation_server_ca_file\n\ * attestation_port\n* attestation_api_url\n* attestation_auth_blob\n* attestation_insecure_ssl\n" max: null metavar: null min: null mutable: false name: attestation_auth_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: attestation_insecure_ssl help: ' When set to True, the SSL certificate verification is skipped for the attestation service. See the `attestation_server` help text for more information about host verification. 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_auth_timeout ' max: null metavar: null min: null mutable: false name: attestation_insecure_ssl namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value upgrade_levels: help: ' upgrade_levels options are used to set version cap for RPC messages sent between different nova services. By default all services send messages using the latest version they know about. The compute upgrade level is an important part of rolling upgrades where old and new nova-compute services run side by side. The other options can largely be ignored, and are only kept to help with a possible future backport issue. ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: compute help: "\nCompute RPC API version cap.\n\nBy default, we always send messages\ \ using the most recent version\nthe client knows about.\n\nWhere you have\ \ old and new compute services running, you should set\nthis to the lowest\ \ deployed version. This is to guarantee that all\nservices never send messages\ \ that one of the compute nodes can't\nunderstand. Note that we only support\ \ upgrading from release N to\nrelease N+1.\n\nSet this option to \"auto\"\ \ if you want to let the compute RPC module\nautomatically determine what\ \ version to use based on the service\nversions in the deployment.\n\nPossible\ \ values:\n\n* By default send the latest version the client knows about\n\ * 'auto': Automatically determines what version to use based on\n the service\ \ versions in the deployment.\n* A string representing a version number in\ \ the format 'N.N';\n for example, possible values might be '1.12' or '2.0'.\n\ * An OpenStack release name, in lower case, such as 'mitaka' or\n 'liberty'.\n" max: null metavar: null min: null mutable: false name: compute namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cells help: Cells RPC API version cap max: null metavar: null min: null mutable: false name: cells namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: intercell help: Intercell RPC API version cap max: null metavar: null min: null mutable: false name: intercell namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cert help: Cert RPC API version cap max: null metavar: null min: null mutable: false name: cert namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: scheduler help: Scheduler RPC API version cap max: null metavar: null min: null mutable: false name: scheduler namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: conductor help: Conductor RPC API version cap max: null metavar: null min: null mutable: false name: conductor namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: console help: Console RPC API version cap max: null metavar: null min: null mutable: false name: console namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: consoleauth help: Consoleauth RPC API version cap max: null metavar: null min: null mutable: false name: consoleauth namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: network help: Network RPC API version cap max: null metavar: null min: null mutable: false name: network namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: baseapi help: Base API RPC API version cap max: null metavar: null min: null mutable: false name: baseapi namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value vendordata_dynamic_auth: help: ' Options within this group control the authentication of the vendordata subsystem of the metadata API server (and config drive) with external systems. ' opts: - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cafile help: PEM encoded Certificate Authority to use when verifying HTTPs connections. max: null metavar: null min: null mutable: false name: cafile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: certfile help: PEM encoded client certificate cert file max: null metavar: null min: null mutable: false name: certfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: keyfile help: PEM encoded client certificate key file max: null metavar: null min: null mutable: false name: keyfile namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: Verify HTTPS connections. max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: timeout help: Timeout value for http requests max: null metavar: null min: null mutable: false name: timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: vendordata_dynamic_auth name: auth_plugin deprecated_reason: null deprecated_since: null dest: auth_type help: Authentication type to load max: null metavar: null min: null mutable: false name: auth_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_section help: Config Section from which to load plugin specific options max: null metavar: null min: null mutable: false name: auth_section namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: auth_url help: Authentication URL max: null metavar: null min: null mutable: false name: auth-url namespace: nova.conf positional: false required: true sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_id help: Domain ID to scope to max: null metavar: null min: null mutable: false name: domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: domain_name help: Domain name to scope to max: null metavar: null min: null mutable: false name: domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_id help: Project ID to scope to max: null metavar: null min: null mutable: false name: project-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_name help: Project name to scope to max: null metavar: null min: null mutable: false name: project-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_id help: Domain ID containing project max: null metavar: null min: null mutable: false name: project-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: project_domain_name help: Domain name containing project max: null metavar: null min: null mutable: false name: project-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: trust_id help: Trust ID max: null metavar: null min: null mutable: false name: trust-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_id help: Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_domain_name help: Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. max: null metavar: null min: null mutable: false name: default-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_id help: User ID max: null metavar: null min: null mutable: false name: user-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: vendordata_dynamic_auth name: user_name deprecated_reason: null deprecated_since: null dest: username help: Username max: null metavar: null min: null mutable: false name: username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_id help: User's domain id max: null metavar: null min: null mutable: false name: user-domain-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: user_domain_name help: User's domain name max: null metavar: null min: null mutable: false name: user-domain-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: password help: User's password max: null metavar: null min: null mutable: false name: password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_id help: Tenant ID max: null metavar: null min: null mutable: false name: tenant-id namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: tenant_name help: Tenant Name max: null metavar: null min: null mutable: false name: tenant-name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value vmware: help: ' Related options: Following options must be set in order to launch VMware-based virtual machines. * compute_driver: Must use vmwareapi.VMwareVCDriver. * vmware.host_username * vmware.host_password * vmware.cluster_name ' opts: - advanced: false choices: null default: vmnic0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vlan_interface help: ' This option specifies the physical ethernet adapter name for VLAN networking. Set the vlan_interface configuration option to match the ESX host interface that handles VLAN-tagged VM traffic. Possible values: * Any valid string representing VLAN interface name ' max: null metavar: null min: null mutable: false name: vlan_interface namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: integration_bridge help: ' This option should be configured only when using the NSX-MH Neutron plugin. This is the name of the integration bridge on the ESXi server or host. This should not be set for any other Neutron plugin. Hence the default value is not set. Possible values: * Any valid string representing the name of the integration bridge ' max: null metavar: null min: null mutable: false name: integration_bridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: console_delay_seconds help: ' Set this value if affected by an increased network latency causing repeated characters when typing in a remote console. ' max: null metavar: null min: 0 mutable: false name: console_delay_seconds namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: serial_port_service_uri help: ' Identifies the remote system where the serial port traffic will be sent. This option adds a virtual serial port which sends console output to a configurable service URI. At the service URI address there will be virtual serial port concentrator that will collect console logs. If this is not set, no serial ports will be added to the created VMs. Possible values: * Any valid URI ' max: null metavar: null min: null mutable: false name: serial_port_service_uri namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: serial_port_proxy_uri help: ' 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 ' max: null metavar: null min: null mutable: false name: serial_port_proxy_uri namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host_ip help: ' Hostname or IP address for connection to VMware vCenter host.' max: null metavar: null min: null mutable: false name: host_ip namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 443 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host_port help: Port for connection to VMware vCenter host. max: 65535 metavar: null min: 0 mutable: false name: host_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host_username help: Username for connection to VMware vCenter host. max: null metavar: null min: null mutable: false name: host_username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: host_password help: Password for connection to VMware vCenter host. max: null metavar: null min: null mutable: false name: host_password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ca_file help: ' Specifies the CA bundle file to be used in verifying the vCenter server certificate. ' max: null metavar: null min: null mutable: false name: ca_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: insecure help: ' 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. ' max: null metavar: null min: null mutable: false name: insecure namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cluster_name help: Name of a VMware Cluster ComputeResource. max: null metavar: null min: null mutable: false name: cluster_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: datastore_regex help: ' Regular expression pattern to match the name of datastore. The datastore_regex setting specifies the datastores to use with Compute. For example, datastore_regex="nas.*" selects all the data stores that have a name starting with "nas". NOTE: If no regex is given, it just picks the datastore with the most freespace. Possible values: * Any matching regular expression to a datastore must be given ' max: null metavar: null min: null mutable: false name: datastore_regex namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 0.5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: task_poll_interval help: ' Time interval in seconds to poll remote tasks invoked on VMware VC server. ' max: null metavar: null min: null mutable: false name: task_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: api_retry_count help: ' Number of times VMware vCenter server API must be retried on connection failures, e.g. socket error, etc. ' max: null metavar: null min: 0 mutable: false name: api_retry_count namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5900 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vnc_port help: ' This option specifies VNC starting port. Every VM created by ESX host has an option of enabling VNC client for remote connection. Above option ''vnc_port'' helps you to set default starting port for the VNC client. Possible values: * Any valid port number within 5900 -(5900 + vnc_port_total) Related options: Below options should be set to enable VNC client. * vnc.enabled = True * vnc_port_total ' max: 65535 metavar: null min: 0 mutable: false name: vnc_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 10000 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vnc_port_total help: ' Total number of VNC ports. ' max: null metavar: null min: 0 mutable: false name: vnc_port_total namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_linked_clone help: ' This option enables/disables the use of linked clone. The ESX hypervisor requires a copy of the VMDK file in order to boot up a virtual machine. The compute driver must download the VMDK via HTTP from the OpenStack Image service to a datastore that is visible to the hypervisor and cache it. Subsequent virtual machines that need the VMDK use the cached version and don''t have to copy the file again from the OpenStack Image service. If set to false, even with a cached VMDK, there is still a copy operation from the cache location to the hypervisor file directory in the shared datastore. If set to true, the above copy operation is avoided as it creates copy of the virtual machine that shares virtual disks with its parent VM. ' max: null metavar: null min: null mutable: false name: use_linked_clone namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: Only vCenter versions earlier than 5.1 require this option and the current minimum version is 5.1. deprecated_since: 15.0.0 dest: wsdl_location help: ' 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:///vimService.wsdl * file:///opt/stack/vmware/SDK/wsdl/vim25/vimService.wsdl ' max: null metavar: null min: null mutable: false name: wsdl_location namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pbm_enabled help: ' This option enables or disables storage policy based placement of instances. Related options: * pbm_default_policy ' max: null metavar: null min: null mutable: false name: pbm_enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pbm_wsdl_location help: "\nThis option specifies the PBM service WSDL file location URL.\n\nSetting\ \ this will disable storage policy based placement\nof instances.\n\nPossible\ \ values:\n\n* Any valid file path\n e.g file:///opt/SDK/spbm/wsdl/pbmService.wsdl\n" max: null metavar: null min: null mutable: false name: pbm_wsdl_location namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: pbm_default_policy help: ' This option specifies the default policy to be used. If pbm_enabled is set and there is no defined storage policy for the specific request, then this policy will be used. Possible values: * Any valid storage policy such as VSAN default storage policy Related options: * pbm_enabled ' max: null metavar: null min: null mutable: false name: pbm_default_policy namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 100 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: maximum_objects help: ' 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. ' max: null metavar: null min: 0 mutable: false name: maximum_objects namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cache_prefix help: ' 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 ' max: null metavar: null min: null mutable: false name: cache_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value vnc: help: ' Virtual Network Computer (VNC) can be used to provide remote desktop console access to instances for tenants and/or administrators.' opts: - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vnc_enabled deprecated_reason: null deprecated_since: null dest: enabled help: ' 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. ' max: null metavar: null min: null mutable: false name: enabled namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: en-us deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vnc_keymap deprecated_reason: null deprecated_since: null dest: keymap help: "\nKeymap for VNC.\n\nThe keyboard mapping (keymap) determines which keyboard\ \ layout a VNC\nsession should use by default.\n\nPossible values:\n\n* A\ \ keyboard layout which is supported by the underlying hypervisor on\n this\ \ node. This is usually an 'IETF language tag' (for example\n 'en-us'). \ \ If you use QEMU as hypervisor, you should find the list\n of supported\ \ keyboard layouts at ``/usr/share/qemu/keymaps``.\n" max: null metavar: null min: null mutable: false name: keymap namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vncserver_listen deprecated_reason: null deprecated_since: null dest: vncserver_listen help: ' The IP address or hostname on which an instance should listen to for incoming VNC connection requests on this node. ' max: null metavar: null min: null mutable: false name: vncserver_listen namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 127.0.0.1 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: vncserver_proxyclient_address deprecated_reason: null deprecated_since: null dest: vncserver_proxyclient_address help: ' 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. ' max: null metavar: null min: null mutable: false name: vncserver_proxyclient_address namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: http://127.0.0.1:6080/vnc_auto.html deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: novncproxy_base_url deprecated_reason: null deprecated_since: null dest: novncproxy_base_url help: ' 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 ' max: null metavar: null min: null mutable: false name: novncproxy_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: xvpvncproxy_host deprecated_reason: null deprecated_since: null dest: xvpvncproxy_host help: ' 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 ' max: null metavar: null min: null mutable: false name: xvpvncproxy_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 6081 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: xvpvncproxy_port deprecated_reason: null deprecated_since: null dest: xvpvncproxy_port help: ' Port 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 port to which the XVP VNC console proxy service should bind to. Related options: * xvpvncproxy_host * xvpvncproxy_base_url ' max: 65535 metavar: null min: 0 mutable: false name: xvpvncproxy_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: http://127.0.0.1:6081/console deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: xvpvncproxy_base_url deprecated_reason: null deprecated_since: null dest: xvpvncproxy_base_url help: ' Public URL address of XVP VNC console proxy. 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 public base URL to which client systems will connect. XVP clients can use this address to connect to the XVP instance and, by extension, the VNC sessions. Related options: * xvpvncproxy_host * xvpvncproxy_port ' max: null metavar: null min: null mutable: false name: xvpvncproxy_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: uri value - advanced: false choices: null default: 0.0.0.0 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: novncproxy_host deprecated_reason: null deprecated_since: null dest: novncproxy_host help: ' IP address 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 address to which the noVNC console proxy service should bind to. Related options: * novncproxy_port * novncproxy_base_url ' max: null metavar: null min: null mutable: false name: novncproxy_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 6080 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: novncproxy_port deprecated_reason: null deprecated_since: null dest: novncproxy_port help: ' 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 ' max: 65535 metavar: null min: 0 mutable: false name: novncproxy_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value workarounds: help: ' A collection of workarounds used to mitigate bugs or issues found in system tools (e.g. Libvirt or QEMU) or Nova itself under certain conditions. These should only be enabled in exceptional circumstances. All options are linked against bug IDs, where more information on the issue can be found. ' opts: - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disable_rootwrap help: "\nUse sudo instead of rootwrap.\n\nAllow fallback to sudo for performance\ \ reasons.\n\nFor more information, refer to the bug report:\n\n https://bugs.launchpad.net/nova/+bug/1415106\n\ \nPossible values:\n\n* True: Use sudo instead of rootwrap\n* False: Use rootwrap\ \ as usual\n\nInterdependencies to other options:\n\n* Any options that affect\ \ 'rootwrap' will be ignored.\n" max: null metavar: null min: null mutable: false name: disable_rootwrap namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disable_libvirt_livesnapshot help: "\nDisable live snapshots when using the libvirt driver.\n\nLive snapshots\ \ allow the snapshot of the disk to happen without an\ninterruption to the\ \ guest, using coordination with a guest agent to\nquiesce the filesystem.\n\ \nWhen using libvirt 1.2.2 live snapshots fail intermittently under load\n\ (likely related to concurrent libvirt/qemu operations). This config\noption\ \ provides a mechanism to disable live snapshot, in favor of cold\nsnapshot,\ \ while this is resolved. Cold snapshot causes an instance\noutage while the\ \ guest is going through the snapshotting process.\n\nFor more information,\ \ refer to the bug report:\n\n https://bugs.launchpad.net/nova/+bug/1334398\n\ \nPossible values:\n\n* True: Live snapshot is disabled when using libvirt\n\ * False: Live snapshots are always used when snapshotting (as long as\n there\ \ is a new enough libvirt and the backend storage supports it)\n" max: null metavar: null min: null mutable: false name: disable_libvirt_livesnapshot namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: handle_virt_lifecycle_events help: "\nEnable handling of events emitted from compute drivers.\n\nMany compute\ \ drivers emit lifecycle events, which are events that occur when,\nfor example,\ \ an instance is starting or stopping. If the instance is going\nthrough task\ \ state changes due to an API operation, like resize, the events\nare ignored.\n\ \nThis is an advanced feature which allows the hypervisor to signal to the\n\ compute service that an unexpected state change has occurred in an instance\n\ and that the instance can be shutdown automatically. Unfortunately, this can\n\ race in some conditions, for example in reboot operations or when the compute\n\ service or when host is rebooted (planned or due to an outage). If such races\n\ are common, then it is advisable to disable this feature.\n\nCare should be\ \ taken when this feature is disabled and\n'sync_power_state_interval' is\ \ set to a negative value. In this case, any\ninstances that get out of sync\ \ between the hypervisor and the Nova database\nwill have to be synchronized\ \ manually.\n\nFor more information, refer to the bug report:\n\n https://bugs.launchpad.net/bugs/1444630\n\ \nInterdependencies to other options:\n\n* If ``sync_power_state_interval``\ \ is negative and this feature is disabled,\n then instances that get out\ \ of sync between the hypervisor and the Nova\n database will have to be\ \ synchronized manually.\n" max: null metavar: null min: null mutable: false name: handle_virt_lifecycle_events namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value wsgi: help: ' Options under this group are used to configure WSGI (Web Server Gateway Interface). WSGI is used to serve API requests. ' opts: - advanced: false choices: null default: api-paste.ini deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: api_paste_config deprecated_reason: null deprecated_since: null dest: api_paste_config help: ' 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. ' max: null metavar: null min: null mutable: false name: api_paste_config namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: '%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f' deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: wsgi_log_format deprecated_reason: null deprecated_since: null dest: wsgi_log_format help: "\nIt represents a python format string that is used as the template to\ \ generate\nlog lines. The following values can be formatted into it: client_ip,\n\ date_time, request_line, status_code, body_length, wall_seconds.\n\nThis option\ \ is used for building custom request loglines.\n\nPossible values:\n\n* '%(client_ip)s\ \ \"%(request_line)s\" status: %(status_code)s'\n 'len: %(body_length)s time:\ \ %(wall_seconds).7f' (default)\n* Any formatted string formed by specific\ \ values.\n" max: null metavar: null min: null mutable: false name: wsgi_log_format namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: secure_proxy_ssl_header deprecated_reason: null deprecated_since: null dest: secure_proxy_ssl_header help: ' This option specifies the HTTP header used to determine the protocol scheme for the original request, even if it was removed by a SSL terminating proxy. Possible values: * None (default) - the request scheme is not influenced by any HTTP headers. * Valid HTTP header, like HTTP_X_FORWARDED_PROTO ' max: null metavar: null min: null mutable: false name: secure_proxy_ssl_header namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_ca_file deprecated_reason: null deprecated_since: null dest: ssl_ca_file help: ' 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 ' max: null metavar: null min: null mutable: false name: ssl_ca_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_cert_file deprecated_reason: null deprecated_since: null dest: ssl_cert_file help: ' This option allows setting path to the SSL certificate of API server. Possible values: * String representing path to the SSL certificate. Related options: * enabled_ssl_apis ' max: null metavar: null min: null mutable: false name: ssl_cert_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: ssl_key_file deprecated_reason: null deprecated_since: null dest: ssl_key_file help: ' 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 ' max: null metavar: null min: null mutable: false name: ssl_key_file namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 600 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: tcp_keepidle deprecated_reason: null deprecated_since: null dest: tcp_keepidle help: ' This option sets the value of TCP_KEEPIDLE in seconds for each server socket. It specifies the duration of time to keep connection active. TCP generates a KEEPALIVE transmission for an application that requests to keep connection active. Not supported on OS X. Related options: * keep_alive ' max: null metavar: null min: 0 mutable: false name: tcp_keepidle namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1000 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: wsgi_default_pool_size deprecated_reason: null deprecated_since: null dest: default_pool_size help: ' This option specifies the size of the pool of greenthreads used by wsgi. It is possible to limit the number of concurrent connections using this option. ' max: null metavar: null min: 0 mutable: false name: default_pool_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 16384 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: max_header_line deprecated_reason: null deprecated_since: null dest: max_header_line help: ' 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. ' max: null metavar: null min: 0 mutable: false name: max_header_line namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: wsgi_keep_alive deprecated_reason: null deprecated_since: null dest: keep_alive help: ' This option allows using the same TCP connection to send and receive multiple HTTP requests/responses, as opposed to opening a new one for every single request/response pair. HTTP keep-alive indicates HTTP connection reuse. Possible values: * True : reuse HTTP connection. * False : closes the client socket connection explicitly. Related options: * tcp_keepidle ' max: null metavar: null min: null mutable: false name: keep_alive namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 900 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: client_socket_timeout deprecated_reason: null deprecated_since: null dest: client_socket_timeout help: ' This option specifies the timeout for client connections'' socket operations. If an incoming connection is idle for this number of seconds it will be closed. It indicates timeout on individual read/writes on the socket connection. To wait forever set to 0. ' max: null metavar: null min: 0 mutable: false name: client_socket_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value xenserver: help: ' XenServer options are used when the compute_driver is set to use XenServer (compute_driver=xenapi.XenAPIDriver). Must specify connection_url, connection_password and ovs_integration_bridge to use compute_driver=xenapi.XenAPIDriver. ' opts: - advanced: false choices: null default: 30 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: agent_timeout help: ' 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`` ' max: null metavar: null min: 0 mutable: false name: agent_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 300 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: agent_version_timeout help: ' Number of seconds to wait for agent''t reply to version request. This indicates the amount of time xapi ''agent'' plugin waits for the agent to respond to the ''version'' request specifically. The generic timeout for agent communication ``agent_timeout`` is ignored in this case. During the build process the ''version'' request is used to determine if the agent is available/operational to perform other requests such as ''resetnetwork'', ''password'', ''key_init'' and ''inject_file''. If the ''version'' call fails, the other configuration is skipped. So, this configuration option can also be interpreted as time in which agent is expected to be fully operational. ' max: null metavar: null min: 0 mutable: false name: agent_version_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: agent_resetnetwork_timeout help: ' Number of seconds to wait for agent''s reply to resetnetwork request. This indicates the amount of time xapi ''agent'' plugin waits for the agent to respond to the ''resetnetwork'' request specifically. The generic timeout for agent communication ``agent_timeout`` is ignored in this case. ' max: null metavar: null min: 0 mutable: false name: agent_resetnetwork_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: usr/sbin/xe-update-networking deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: agent_path help: ' 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`` ' max: null metavar: null min: null mutable: false name: agent_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: disable_agent help: ' Disables the use of XenAPI agent. This configuration option suggests whether the use of agent should be enabled or not regardless of what image properties are present. Image properties have an effect only when this is set to ``True``. Read description of config option ``use_agent_default`` for more information. Related options: * ``use_agent_default`` ' max: null metavar: null min: null mutable: false name: disable_agent namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_agent_default help: ' 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`` ' max: null metavar: null min: null mutable: false name: use_agent_default namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: login_timeout help: Timeout in seconds for XenAPI login. max: null metavar: null min: 0 mutable: false name: login_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 5 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_concurrent help: ' Maximum number of concurrent XenAPI connections. In nova, multiple XenAPI requests can happen at a time. Configuring this option will parallelize access to the XenAPI session, which allows you to make concurrent XenAPI connections. ' max: null metavar: null min: 1 mutable: false name: connection_concurrent namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_base_url help: ' Base URL for torrent files; must contain a slash character (see RFC 1808, step 6). ' max: null metavar: null min: null mutable: false name: torrent_base_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 1.0 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_seed_chance help: Probability that peer will become a seeder (1.0 = 100%) max: null metavar: null min: 0 mutable: false name: torrent_seed_chance namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: 3600 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_seed_duration help: ' Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers.'' ' max: null metavar: null min: null mutable: false name: torrent_seed_duration namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 86400 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_max_last_accessed help: ' Cached torrent files not accessed within this number of seconds can be reaped. ' max: null metavar: null min: 0 mutable: false name: torrent_max_last_accessed namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 6881 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_listen_port_start help: Beginning of port range to listen on max: 65535 metavar: null min: 0 mutable: false name: torrent_listen_port_start namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 6891 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_listen_port_end help: End of port range to listen on max: 65535 metavar: null min: 0 mutable: false name: torrent_listen_port_end namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: 600 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_download_stall_cutoff help: ' Number of seconds a download can remain at the same progress percentage w/o being considered a stall. ' max: null metavar: null min: 0 mutable: false name: torrent_download_stall_cutoff namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 1 deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' The torrent feature has not been tested nor maintained, and as such is being removed. ' deprecated_since: 15.0.0 dest: torrent_max_seeder_processes_per_host help: ' Maximum number of seeder processes to run concurrently within a given dom0 (-1 = no limit). ' max: null metavar: null min: -1 mutable: false name: torrent_max_seeder_processes_per_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - all - some - none default: all deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: cache_images help: "\nCache glance images locally.\n\nThe value for this option must be chosen\ \ from the choices listed\nhere. Configuring a value other than these will\ \ default to 'all'.\n\nNote: There is nothing that deletes these images.\n\ \nPossible values:\n\n* `all`: will cache all images.\n* `some`: will only\ \ cache images that have the\n image_property `cache_in_nova=True`.\n* `none`:\ \ turns off caching entirely.\n" max: null metavar: null min: null mutable: false name: cache_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: image_compression_level help: "\nCompression level for images.\n\nBy setting this option we can configure\ \ the gzip compression level.\nThis option sets GZIP environment variable\ \ before spawning tar -cz\nto force the compression level. It defaults to\ \ none, which means the\nGZIP environment variable is not set and the default\ \ (usually -6)\nis used.\n\nPossible values:\n\n* Range is 1-9, e.g., 9 for\ \ gzip -9, 9 being most\n compressed but most CPU intensive on dom0.\n* Any\ \ values out of this range will default to None.\n" max: 9 metavar: null min: 1 mutable: false name: image_compression_level namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: linux deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: default_os_type help: Default OS type used when uploading an image to glance max: null metavar: null min: null mutable: false name: default_os_type namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: block_device_creation_timeout help: Time in secs to wait for a block device to be created max: null metavar: null min: 1 mutable: false name: block_device_creation_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: 16777216 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: max_kernel_ramdisk_size help: ' 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. ' max: null metavar: null min: null mutable: false name: max_kernel_ramdisk_size namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: default-sr:true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sr_matching_filter help: "\nFilter for finding the SR to be used to install guest instances on.\n\ \nPossible values:\n\n* To use the Local Storage in default XenServer/XCP\ \ installations\n set this flag to other-config:i18n-key=local-storage.\n\ * To select an SR with a different matching criteria, you could\n set it\ \ to other-config:my_favorite_sr=true.\n* To fall back on the Default SR,\ \ as displayed by XenCenter,\n set this flag to: default-sr:true.\n" max: null metavar: null min: null mutable: false name: sr_matching_filter namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sparse_copy help: ' Whether to use sparse_copy for copying data on a resize down. (False will use standard dd). This speeds up resizes down considerably since large runs of zeros won''t have to be rsynced. ' max: null metavar: null min: null mutable: false name: sparse_copy namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 10 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: num_vbd_unplug_retries help: ' Maximum number of retries to unplug VBD. If set to 0, should try once, no retries. ' max: null metavar: null min: 0 mutable: false name: num_vbd_unplug_retries namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: - all - some - none default: none deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: torrent_images help: "\nWhether or not to download images via Bit Torrent.\n\nThe value for\ \ this option must be chosen from the choices listed\nhere. Configuring a\ \ value other than these will default to 'none'.\n\nPossible values:\n\n*\ \ `all`: will download all images.\n* `some`: will only download images that\ \ have the image_property\n `bittorrent=true'.\n* `none`: will turnoff\ \ downloading images via Bit Torrent.\n" max: null metavar: null min: null mutable: false name: torrent_images namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ipxe_network_name help: ' 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` ' max: null metavar: null min: null mutable: false name: ipxe_network_name namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ipxe_boot_menu_url help: ' 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` ' max: null metavar: null min: null mutable: false name: ipxe_boot_menu_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: mkisofs deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ipxe_mkisofs_cmd help: ' Name and optionally path of the tool used for ISO image creation. An iPXE ISO is a specially crafted ISO which supports iPXE booting. This feature gives a means to roll your own image. Note: By default `mkisofs` is not present in the Dom0, so the package can either be manually added to Dom0 or include the `mkisofs` binary in the image itself. Related Options: * `ipxe_network_name` * `ipxe_boot_menu_url` ' max: null metavar: null min: null mutable: false name: ipxe_mkisofs_cmd namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_url help: "\nURL for connection to XenServer/Xen Cloud Platform. A special value\n\ of unix://local can be used to connect to the local unix socket.\n\nPossible\ \ values:\n\n* Any string that represents a URL. The connection_url is\n \ \ generally the management network IP address of the XenServer.\n* This option\ \ must be set if you chose the XenServer driver.\n" max: null metavar: null min: null mutable: false name: connection_url namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: root deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_username help: Username for connection to XenServer/Xen Cloud Platform max: null metavar: null min: null mutable: false name: connection_username namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: connection_password help: Password for connection to XenServer/Xen Cloud Platform max: null metavar: null min: null mutable: false name: connection_password namespace: nova.conf positional: false required: false sample_default: null secret: true short: null type: string value - advanced: false choices: null default: 5.0 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vhd_coalesce_poll_interval help: ' The interval used for polling of coalescing vhds. This is the interval after which the task of coalesce VHD is performed, until it reaches the max attempts that is set by vhd_coalesce_max_attempts. Related options: * `vhd_coalesce_max_attempts` ' max: null metavar: null min: 0 mutable: false name: vhd_coalesce_poll_interval namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: floating point value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: check_host help: "\nEnsure compute service is running on host XenAPI connects to.\nThis\ \ option must be set to false if the 'independent_compute'\noption is set\ \ to true.\n\nPossible values:\n\n* Setting this option to true will make\ \ sure that compute service\n is running on the same host that is specified\ \ by connection_url.\n* Setting this option to false, doesn't perform the\ \ check.\n\nRelated options:\n\n* `independent_compute`\n" max: null metavar: null min: null mutable: false name: check_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 20 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: vhd_coalesce_max_attempts help: ' 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` ' max: null metavar: null min: 0 mutable: false name: vhd_coalesce_max_attempts namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: /var/run/sr-mount deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: sr_base_path help: Base path to the storage repository on the XenServer host. max: null metavar: null min: null mutable: false name: sr_base_path namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: target_host help: ' The iSCSI Target Host. This option represents the hostname or ip of the iSCSI Target. If the target host is not present in the connection information from the volume provider then the value from this option is taken. Possible values: * Any string that represents hostname/ip of Target. ' max: null metavar: null min: null mutable: false name: target_host namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 3260 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: target_port help: ' 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. ' max: 65535 metavar: null min: 0 mutable: false name: target_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value - advanced: false choices: null default: false deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' This option provided a workaround for issues in Ubuntu Maverick, which was released in April 2010 and was dropped from support in April 2012. There''s no reason to continue supporting this option. ' deprecated_since: 15.0.0 dest: remap_vbd_dev help: ' Used to enable the remapping of VBD dev. (Works around an issue in Ubuntu Maverick) ' max: null metavar: null min: null mutable: false name: remap_vbd_dev namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: sd deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: remap_vbd_dev_prefix help: ' 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. ' max: null metavar: null min: null mutable: false name: remap_vbd_dev_prefix namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: false deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: independent_compute help: ' 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) ' max: null metavar: null min: null mutable: false name: independent_compute namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: 60 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: running_timeout help: ' Wait time for instances to go to running state. Provide an integer value representing time in seconds to set the wait time for an instance to go to running state. When a request to create an instance is received by nova-api and communicated to nova-compute, the creation of the instance occurs through interaction with Xen via XenAPI in the compute node. Once the node on which the instance(s) are to be launched is decided by nova-schedule and the launch is triggered, a certain amount of wait time is involved until the instance(s) can become available and ''running''. This wait time is defined by running_timeout. If the instances do not go to running state within this specified wait time, the launch expires and the instance(s) are set to ''error'' state. ' max: null metavar: null min: 0 mutable: false name: running_timeout namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: nova.virt.xenapi.vif.XenAPIOpenVswitchDriver deprecated_for_removal: true deprecated_opts: [] deprecated_reason: ' There are only two in-tree vif drivers for XenServer. XenAPIBridgeDriver is for nova-network which is deprecated and XenAPIOpenVswitchDriver is for Neutron which is the default configuration for Nova since the 15.0.0 Ocata release. In the future the "use_neutron" configuration option will be used to determine which vif driver to use. ' deprecated_since: 15.0.0 dest: vif_driver help: ' The XenAPI VIF driver using XenServer Network APIs. Provide a string value representing the VIF XenAPI vif driver to use for plugging virtual network interfaces. Xen configuration uses bridging within the backend domain to allow all VMs to appear on the network as individual hosts. Bridge interfaces are used to create a XenServer VLAN network in which the VIFs for the VM instances are plugged. If no VIF bridge driver is plugged, the bridge is not made available. This configuration option takes in a value for the VIF driver. Possible values: * nova.virt.xenapi.vif.XenAPIOpenVswitchDriver (default) * nova.virt.xenapi.vif.XenAPIBridgeDriver (deprecated) Related options: * ``vlan_interface`` * ``ovs_integration_bridge`` ' max: null metavar: null min: null mutable: false name: vif_driver namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: nova.virt.xenapi.image.glance.GlanceStore deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: image_upload_handler help: ' Dom0 plugin driver used to handle image uploads. Provide a string value representing a plugin driver required to handle the image uploading to GlanceStore. Images, and snapshots from XenServer need to be uploaded to the data store for use. image_upload_handler takes in a value for the Dom0 plugin driver. This driver is then called to uplaod images to the GlanceStore. ' max: null metavar: null min: null mutable: false name: image_upload_handler namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 20 deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: introduce_vdi_retry_wait help: ' Number of seconds to wait for SR to settle if the VDI does not exist when first introduced. Some SRs, particularly iSCSI connections are slow to see the VDIs right after they got introduced. Setting this option to a time interval will make the SR to wait for that time period before raising VDI not found exception. ' max: null metavar: null min: 0 mutable: false name: introduce_vdi_retry_wait namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: integer value - advanced: false choices: null default: null deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: ovs_integration_bridge help: ' 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 values: * Any string that represents a bridge name. ' max: null metavar: null min: null mutable: false name: ovs_integration_bridge namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: true deprecated_for_removal: false deprecated_opts: [] deprecated_reason: null deprecated_since: null dest: use_join_force help: ' When adding new host to a pool, this will append a --force flag to the command, forcing hosts to join a pool, even if they have different CPUs. Since XenServer version 5.6 it is possible to create a pool of hosts that have different CPU capabilities. To accommodate CPU differences, XenServer limited features it uses to determine CPU compatibility to only the ones that are exposed by CPU and support for CPU masking was added. Despite this effort to level differences between CPUs, it is still possible that adding new host will fail, thus option to force join was introduced. ' max: null metavar: null min: null mutable: false name: use_join_force namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: boolean value - advanced: false choices: null default: openstack.novalocal deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_public_hostname deprecated_reason: null deprecated_since: null dest: console_public_hostname help: ' Publicly visible name for this console host. Possible values: * A string representing a valid hostname ' max: null metavar: null min: null mutable: false name: console_public_hostname namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value xvp: help: ' Configuration options for XVP. xvp (Xen VNC Proxy) is a proxy server providing password-protected VNC-based access to the consoles of virtual machines hosted on Citrix XenServer. ' opts: - advanced: false choices: null default: $pybasedir/nova/console/xvp.conf.template deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_xvp_conf_template deprecated_reason: null deprecated_since: null dest: console_xvp_conf_template help: XVP conf template max: null metavar: null min: null mutable: false name: console_xvp_conf_template namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /etc/xvp.conf deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_xvp_conf deprecated_reason: null deprecated_since: null dest: console_xvp_conf help: Generated XVP conf file max: null metavar: null min: null mutable: false name: console_xvp_conf namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /var/run/xvp.pid deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_xvp_pid deprecated_reason: null deprecated_since: null dest: console_xvp_pid help: XVP master process pid file max: null metavar: null min: null mutable: false name: console_xvp_pid namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: /var/log/xvp.log deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_xvp_log deprecated_reason: null deprecated_since: null dest: console_xvp_log help: XVP log file max: null metavar: null min: null mutable: false name: console_xvp_log namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: string value - advanced: false choices: null default: 5900 deprecated_for_removal: false deprecated_opts: - group: DEFAULT name: console_xvp_multiplex_port deprecated_reason: null deprecated_since: null dest: console_xvp_multiplex_port help: Port for XVP to multiplex VNC connections on max: 65535 metavar: null min: 0 mutable: false name: console_xvp_multiplex_port namespace: nova.conf positional: false required: false sample_default: null secret: false short: null type: port value