Edit System Configuration

To edit the system configuration parameters (System, Backups/Templates, Interface, Defaults) on the /settings/edit page, use the following request:

PUT /settings.xml
PUT /settings.json

XML Request Example

curl -i -X PUT http://onapp.test/settings.xml?restart=1 -d '<configuration>  <force_saml_login_only type="boolean">false</force_saml_login_only>
  <system_notification type="boolean">false</system_notification>
  <enable_notifications type="boolean">true</enable_notifications>
  <pagination_max_items_limit type="integer">100</pagination_max_items_limit>
  <storage_unicast type="boolean">false</storage_unicast>
  <enable_daily_storage_report type="boolean">false</enable_daily_storage_report>
  <enable_hourly_storage_report type="boolean">false</enable_hourly_storage_report>
  <session_timeout type="integer">480</session_timeout>
  <disable_plain_password_for_api type="boolean">false</disable_plain_password_for_api>
  <max_network_interface_port_speed type="integer">9090</max_network_interface_port_speed>
  <nsx_polling_interval type="integer">60</nsx_polling_interval>
  <ssl_pem_path nil="true"/>
  <use_yubikey_login type="boolean">true</use_yubikey_login>
  <totp_enabled type="boolean">false</totp_enabled>
  <rabbitmq_port type="integer">5672</rabbitmq_port>
  <rabbitmq_continuation_timeout type="integer">15000</rabbitmq_continuation_timeout>
  <allow_incremental_backups type="boolean">false</allow_incremental_backups>
  <use_ssh_file_transfer type="boolean">false</use_ssh_file_transfer>
  <ssh_file_transfer_options>-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PasswordAuthentication=no</ssh_file_transfer_options>
  <ssh_port type="integer">22</ssh_port>
  <ssh_timeout type="integer">30</ssh_timeout>
  <delete_template_source_after_install type="boolean">false</delete_template_source_after_install>
  <generate_comment># Automatically generated by OnApp (6.2.0-112)</generate_comment>
  <simultaneous_backups type="integer">10</simultaneous_backups>
  <simultaneous_backups_per_datastore type="integer">10</simultaneous_backups_per_datastore>
  <simultaneous_backups_per_hypervisor type="integer">10</simultaneous_backups_per_hypervisor>
  <simultaneous_transactions type="integer">20</simultaneous_transactions>
  <simultaneous_storage_resync_transactions type="integer">3</simultaneous_storage_resync_transactions>
  <simultaneous_personal_deliviries type="integer">5</simultaneous_personal_deliviries>
  <simultaneous_vcenter_hypervisors_sync type="integer">1</simultaneous_vcenter_hypervisors_sync>
  <guest_wait_time_before_destroy type="integer">60</guest_wait_time_before_destroy>
  <remote_access_session_start_port type="integer">30000</remote_access_session_start_port>
  <remote_access_session_last_port type="integer">30099</remote_access_session_last_port>
  <ajax_power_update_time type="integer">8000</ajax_power_update_time>
  <ajax_pagination_update_time type="integer">9000</ajax_pagination_update_time>
  <ajax_log_update_interval type="integer">5000</ajax_log_update_interval>
  <hypervisor_live_times type="integer">12</hypervisor_live_times>
  <disable_hypervisor_failover type="boolean">false</disable_hypervisor_failover>
  <locales type="array">
  <max_memory_ratio type="integer">16</max_memory_ratio>
  <kvm_max_memory_rate type="integer">8</kvm_max_memory_rate>
  <kvm_available_free_memory_percentage type="integer">90</kvm_available_free_memory_percentage>
  <default_image_template type="integer">5</default_image_template>
  <show_ip_address_selection_for_new_vm type="boolean">false</show_ip_address_selection_for_new_vm>
  <backup_taker_delay type="integer">300</backup_taker_delay>
  <cluster_monitor_delay type="integer">5</cluster_monitor_delay>
  <hypervisor_monitor_delay type="integer">5</hypervisor_monitor_delay>
  <cdn_sync_delay type="integer">300</cdn_sync_delay>
  <schedule_runner_delay type="integer">60</schedule_runner_delay>
  <transaction_runner_delay type="integer">300</transaction_runner_delay>
  <transaction_approvals type="boolean">false</transaction_approvals>
  <billing_transaction_runner_delay type="integer">60</billing_transaction_runner_delay>
  <zombie_transaction_time type="integer">1</zombie_transaction_time>
  <zombie_disk_space_updater_delay type="integer">300</zombie_disk_space_updater_delay>
  <run_recipe_on_vs_sleep_seconds type="integer">10</run_recipe_on_vs_sleep_seconds>
  <dns_enabled type="boolean">false</dns_enabled>
  <allow_start_vms_with_one_ip type="boolean">false</allow_start_vms_with_one_ip>
  <allow_initial_root_password_encryption type="boolean">true</allow_initial_root_password_encryption>
  <wipe_out_disk_on_destroy type="boolean">false</wipe_out_disk_on_destroy>
  <partition_align_offset type="integer">2048</partition_align_offset>
  <password_enforce_complexity type="boolean">false</password_enforce_complexity>
  <password_minimum_length type="integer">12</password_minimum_length>
  <password_upper_lowercase type="boolean">true</password_upper_lowercase>
  <password_letters_numbers type="boolean">true</password_letters_numbers>
  <password_symbols type="boolean">true</password_symbols>
  <password_force_unique type="boolean">true</password_force_unique>
  <password_lockout_attempts type="integer">3</password_lockout_attempts>
  <password_expiry type="integer">1</password_expiry>
  <password_history_length type="integer">12</password_history_length>
  <cloud_boot_enabled type="boolean">false</cloud_boot_enabled>
  <io_limiting_enabled type="boolean">true</io_limiting_enabled>
  <default_acceleration_policy type="boolean">true</default_acceleration_policy>
  <default_virsh_console_policy type="boolean">false</default_virsh_console_policy>
  <force_shutdown_on_poweroff_failure type="boolean">false</force_shutdown_on_poweroff_failure>
  <number_of_notifications_to_show type="integer">5</number_of_notifications_to_show>
  <max_ip_addresses_to_assign_simultaneously type="integer">256</max_ip_addresses_to_assign_simultaneously>
  <wizard_resource_reservation_ttl type="integer">10</wizard_resource_reservation_ttl>
  <storage_enabled type="boolean">false</storage_enabled>
  <prefer_local_reads type="boolean">false</prefer_local_reads>
  <intra_hypervisor_balance_threshold_ratio type="integer">5</intra_hypervisor_balance_threshold_ratio>
  <inter_hypervisor_balance_threshold_ratio type="integer">5</inter_hypervisor_balance_threshold_ratio>
  <uniform_node_capacity_threshold_ratio type="integer">5</uniform_node_capacity_threshold_ratio>
  <allow_hypervisor_password_encryption type="boolean">false</allow_hypervisor_password_encryption>
  <archive_stats_period type="integer">1</archive_stats_period>
  <instant_stats_period type="integer">1</instant_stats_period>
  <is_archive_stats_enabled type="boolean">false</is_archive_stats_enabled>
  <disable_billing type="boolean">false</disable_billing>
  <system_alert_reminder_period type="integer">60</system_alert_reminder_period>
  <wrong_activated_logical_volume_alerts type="boolean">false</wrong_activated_logical_volume_alerts>
  <wrong_activated_logical_volume_minutes type="integer">60</wrong_activated_logical_volume_minutes>
  <use_html5_vnc_console type="boolean">true</use_html5_vnc_console>
  <storage_endpoint_override nil="true"/>
  <backup_convert_coefficient type="float">1.1</backup_convert_coefficient>
  <rsync_option_xattrs type="boolean">true</rsync_option_xattrs>
  <rsync_option_acls type="boolean">true</rsync_option_acls>
  <simultaneous_backups_per_backup_server type="integer">10</simultaneous_backups_per_backup_server>
  <smtp_port type="integer">25</smtp_port>
  <smtp_username nil="true"/>
  <smtp_password nil="true"/>
  <smtp_enable_starttls_auto type="boolean">true</smtp_enable_starttls_auto>
  <snmptrap_port type="integer">3162</snmptrap_port>
  <infiniband_cloud_boot_enabled type="boolean">false</infiniband_cloud_boot_enabled>
  <qemu_detach_device_delay type="integer">2</qemu_detach_device_delay>
  <qemu_attach_device_delay type="integer">10</qemu_attach_device_delay>
  <tc_latency type="integer">50</tc_latency>
  <tc_burst type="integer">1</tc_burst>
  <tc_mtu type="integer">33000</tc_mtu>
  <ha_enabled type="boolean">false</ha_enabled>
  <allow_connect_aws type="boolean">true</allow_connect_aws>
  <federation_trusts_only_private type="boolean">false</federation_trusts_only_private>
  <maximum_pending_tasks type="integer">20</maximum_pending_tasks>
  <max_upload_size type="integer">0</max_upload_size>
  <transaction_standby_period type="integer">30</transaction_standby_period>
  <vcenter_synchronization_schedule_period type="integer">90</vcenter_synchronization_schedule_period>
  <ip_history_keep_period type="integer">6</ip_history_keep_period>
  <log_cleanup_enabled type="boolean">false</log_cleanup_enabled>
  <cdn_max_results_per_get_page type="integer">500</cdn_max_results_per_get_page>
  <amount_of_service_instances type="integer">4</amount_of_service_instances>
  <graceful_stop_timeout type="integer">300</graceful_stop_timeout>
  <allow_to_collect_errors type="boolean">false</allow_to_collect_errors>
  <password_protection_for_deleting type="boolean">false</password_protection_for_deleting>
  <draas_enabled type="boolean">false</draas_enabled>
  <draas_shadow_ssh_port type="integer">22</draas_shadow_ssh_port>
  <draas_shadow_vpn_port type="integer">51820</draas_shadow_vpn_port>
  <ping_vms_before_init_failover type="boolean">true</ping_vms_before_init_failover>
  <vcloud_stats_level1_period type="integer">60</vcloud_stats_level1_period>
  <vcloud_stats_level2_period type="integer">180</vcloud_stats_level2_period>
  <vcloud_stats_usage_interval type="integer">20</vcloud_stats_usage_interval>
  <vcloud_prevent_idle_session_timeout type="integer">600</vcloud_prevent_idle_session_timeout>
  <block_size type="integer">8</block_size>
  <enforce_redundancy type="boolean">true</enforce_redundancy>
  <dashboard_stats type="array">
  <migration_rate_limit type="integer">13</migration_rate_limit>
  <simultaneous_migrations_per_hypervisor type="integer">5</simultaneous_migrations_per_hypervisor>
  <allow_advanced_vs_management type="boolean">false</allow_advanced_vs_management>
  <ip_address_reservation_time type="integer">60</ip_address_reservation_time>
  <enable_super_admin_permissions type="boolean">false</enable_super_admin_permissions>
  <snmp_stats_level1_period type="integer">10</snmp_stats_level1_period>
  <snmp_stats_level2_period type="integer">60</snmp_stats_level2_period>
  <snmp_stats_level3_period type="integer">120</snmp_stats_level3_period>
  <vcenter_l1_stats_timeout type="integer">180</vcenter_l1_stats_timeout>
  <vcenter_l2_stats_timeout type="integer">600</vcenter_l2_stats_timeout>
  <action_global_lock_expiration_timeout type="integer">1800000</action_global_lock_expiration_timeout>
  <action_global_lock_retry_delay type="integer">10000</action_global_lock_retry_delay>
  <isolated_license type="boolean">false</isolated_license>
  <pagination_dashboard_pages_limit type="integer">20</pagination_dashboard_pages_limit>
  <trusted_proxies type="array">
  <default_timeout type="integer">180</default_timeout>
  <instantiate_vapp_template_timeout type="integer">900</instantiate_vapp_template_timeout>
  <power_on_timeout type="integer">200</power_on_timeout>
  <power_off_timeout type="integer">200</power_off_timeout>
  <suspend_timeout type="integer">600</suspend_timeout>
  <reboot_timeout type="integer">200</reboot_timeout>
  <undeploy_timeout type="integer">720</undeploy_timeout>
  <create_edge_gateway_timeout type="integer">200</create_edge_gateway_timeout>
  <compose_vapp_timeout type="integer">900</compose_vapp_timeout>
  <recompose_vapp_timeout type="integer">900</recompose_vapp_timeout>
  <create_snapshot_timeout type="integer">3600</create_snapshot_timeout>
  <create_vdc_timeout type="integer">200</create_vdc_timeout>
  <capture_vapp_timeout type="integer">900</capture_vapp_timeout>
  <create_vapp_template_timeout type="integer">3600</create_vapp_template_timeout>
  <upload_vapp_template_timeout type="integer">3600</upload_vapp_template_timeout>
  <reset_timeout type="integer">600</reset_timeout>
  <shutdown_timeout type="integer">200</shutdown_timeout>
  <unsuspend_timeout type="integer">600</unsuspend_timeout>
  <upload_media_timeout type="integer">3600</upload_media_timeout>
  <enable_download_timeout type="integer">900</enable_download_timeout>
  <adapter_response_timeout type="integer">60</adapter_response_timeout>
  <adapter_open_connection_timeout type="integer">30</adapter_open_connection_timeout>
  <show_new_wizard type="boolean">true</show_new_wizard>
  <iscsi_port_availability_check_timeout type="integer">5</iscsi_port_availability_check_timeout>
  <max_cpu_quota type="integer">1000</max_cpu_quota>
  <max_memory_quota type="integer">1000</max_memory_quota>
  <global_white_list_ips type="array"/>
  <force_windows_auto_backups type="boolean">false</force_windows_auto_backups></configuration>' -u user:password -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

curl -i -X PUT http://onapptest.com/settings.json?restart=1 -d '{"configuration":{"force_saml_login_only":false,"system_email":"user@onapp.com","system_host":"onapptest.com","system_notification":false,"enable_notifications":true,"system_support_email":"support@onapp.com","system_theme":"light","pagination_max_items_limit":100,"app_name":"OnApp","storage_unicast":false,"enable_daily_storage_report":false,"enable_hourly_storage_report":false,"default_custom_theme":"","session_timeout":480,"disable_plain_password_for_api":false,"max_network_interface_port_speed":9090,"nsx_polling_interval":60,"ssl_pem_path":null,"use_yubikey_login":true,"yubikey_api_key":":yubikey_api_key","yubikey_api_id":"52577","localdomain":"localdomain","totp_enabled":false,"rabbitmq_host":"","rabbitmq_vhost":"/","rabbitmq_login":"rbtvcd","rabbitmq_port":5672,"rabbitmq_password":":rabbitmq_password","rabbitmq_continuation_timeout":15000,"allow_incremental_backups":false,"use_ssh_file_transfer":false,"ssh_file_transfer_server":"","ssh_file_transfer_user":"root","ssh_file_transfer_options":"-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PasswordAuthentication=no","ssh_port":22,"ssh_timeout":30,"template_path":"/onapp/templates","backups_path":"/onapp/backups","data_path":"/onapp/data","update_server_url":"http://templates-manager.onapp.com","delete_template_source_after_install":false,"license_key":":license_key","generate_comment":"# Automatically generated by OnApp (6.2.0-112)","simultaneous_backups":10,"simultaneous_backups_per_datastore":10,"simultaneous_backups_per_hypervisor":10,"simultaneous_transactions":20,"simultaneous_storage_resync_transactions":3,"simultaneous_personal_deliviries":5,"simultaneous_vcenter_hypervisors_sync":1,"guest_wait_time_before_destroy":60,"remote_access_session_start_port":30000,"remote_access_session_last_port":30099,"ajax_power_update_time":8000,"ajax_pagination_update_time":9000,"ajax_log_update_interval":5000,"hypervisor_live_times":12,"iso_path_on_cp":"/data","ova_path":"/data","iso_path_on_hv":"/data","disable_hypervisor_failover":false,"ips_allowed_for_login":"","monitis_path":"/usr/local/monitis","monitis_account":"monitis@onapp.com","monitis_apikey":":monits_apikey","locales":["","en"],"max_memory_ratio":16,"kvm_max_memory_rate":8,"kvm_available_free_memory_percentage":90,"default_image_template":5,"service_account_name":"onapp","default_firewall_policy":"ACCEPT","drop_firewall_policy_allowed_ips":"","show_ip_address_selection_for_new_vm":false,"backup_taker_delay":300,"cluster_monitor_delay":5,"hypervisor_monitor_delay":5,"cdn_sync_delay":300,"schedule_runner_delay":60,"transaction_runner_delay":300,"transaction_approvals":false,"billing_transaction_runner_delay":60,"zombie_transaction_time":1,"zombie_disk_space_updater_delay":300,"run_recipe_on_vs_sleep_seconds":10,"dns_enabled":false,"allow_start_vms_with_one_ip":false,"allow_initial_root_password_encryption":true,"wipe_out_disk_on_destroy":false,"partition_align_offset":2048,"password_enforce_complexity":false,"password_minimum_length":12,"password_upper_lowercase":true,"password_letters_numbers":true,"password_symbols":true,"password_force_unique":true,"password_lockout_attempts":3,"password_expiry":1,"password_history_length":12,"cloud_boot_enabled":false,"io_limiting_enabled":true,"nfs_root_ip":"","cloud_boot_target":"","default_acceleration_policy":true,"default_virsh_console_policy":false,"number_of_notifications_to_show":5,"notification_subject_prefix":"OnApp","max_ip_addresses_to_assign_simultaneously":256,"wizard_resource_reservation_ttl":10,"storage_enabled":false,"prefer_local_reads":false,"intra_hypervisor_balance_threshold_ratio":5,"inter_hypervisor_balance_threshold_ratio":5,"uniform_node_capacity_threshold_ratio":5,"allow_hypervisor_password_encryption":false,"archive_stats_period":1,"instant_stats_period":1,"is_archive_stats_enabled":false,"disable_billing":false,"mysql_billing_transaction_retries":"55","system_alert_reminder_period":60,"wrong_activated_logical_volume_alerts":false,"wrong_activated_logical_volume_minutes":60,"use_html5_vnc_console":true,"storage_endpoint_override":null,"url_for_custom_tools":"","backup_convert_coefficient":1.1,"rsync_option_xattrs":true,"rsync_option_acls":true,"simultaneous_backups_per_backup_server":10,"email_delivery_method":"sendmail","smtp_address":"localhost","smtp_port":25,"smtp_domain":"localhost.localdomain","smtp_username":null,"smtp_password":null,"smtp_authentication":"plain","smtp_enable_starttls_auto":true,"snmptrap_addresses":":","snmptrap_port":3162,"infiniband_cloud_boot_enabled":false,"qemu_detach_device_delay":2,"qemu_attach_device_delay":10,"tc_latency":50,"tc_burst":1,"tc_mtu":33000,"ha_enabled":false,"dashboard_api_access_token":"","allow_connect_aws":true,"federation_trusts_only_private":false,"maximum_pending_tasks":20,"max_upload_size":0,"transaction_standby_period":30,"vcenter_synchronization_schedule_period":90,"ip_history_keep_period":6,"log_cleanup_period":"90","log_cleanup_enabled":false,"log_level":"debug","cdn_max_results_per_get_page":500,"instance_packages_threshold_num":"3","amount_of_service_instances":4,"graceful_stop_timeout":300,"allow_to_collect_errors":false,"password_protection_for_deleting":false,"draas_enabled":false,"draas_shadow_ssh_port":22,"draas_shadow_vpn_port":51820,"draas_vpn_cidr_block":"","zabbix_host":"","zabbix_url":"/zabbix","zabbix_user":"Admin","zabbix_password":"zabbix","ping_vms_before_init_failover":true,"vcloud_stats_level1_period":60,"vcloud_stats_level2_period":180,"vcloud_stats_usage_interval":20,"vcloud_prevent_idle_session_timeout":600,"block_size":8,"cloud_boot_domain_name_servers":":","enforce_redundancy":true,"dashboard_stats":["","cpu","memory","storage","iops","baremetals","smarts","vcloud_cpu","vcloud_memory","vcloud_disks","vcloud_iops","provider_cpu_usage","provider_storage_usage"],"migration_rate_limit":13,"simultaneous_migrations_per_hypervisor":5,"allow_advanced_vs_management":false,"support_help_email":"support@onapp.com","ip_address_reservation_time":60,"recipe_tmp_dir":"/tmp","enable_super_admin_permissions":false,"snmp_stats_level1_period":10,"snmp_stats_level2_period":60,"snmp_stats_level3_period":120,"vcenter_l1_stats_timeout":180,"vcenter_l2_stats_timeout":600,"action_global_lock_expiration_timeout":1800000,"action_global_lock_retry_delay":10000,"isolated_license":false,"pagination_dashboard_pages_limit":20,"trusted_proxies":[":","::1",":0000::/7","",":",":"],"default_timeout":180,"instantiate_vapp_template_timeout":900,"power_on_timeout":200,"power_off_timeout":200,"suspend_timeout":600,"reboot_timeout":200,"undeploy_timeout":720,"create_edge_gateway_timeout":200,"compose_vapp_timeout":900,"recompose_vapp_timeout":900,"create_snapshot_timeout":3600,"create_vdc_timeout":200,"capture_vapp_timeout":900,"create_vapp_template_timeout":3600,"upload_vapp_template_timeout":3600,"reset_timeout":600,"shutdown_timeout":200,"unsuspend_timeout":600,"upload_media_timeout":3600,"enable_download_timeout":900,"adapter_response_timeout":60,"adapter_open_connection_timeout":30,"show_new_wizard":true,"iscsi_port_availability_check_timeout":5,"max_cpu_quota":1000,"max_memory_quota":1000,"global_white_list_ips":[],"force_windows_auto_backups":false}}' -u  user:password -H 'Accept: application/json' -H 'Content-type: application/json'


force_saml_login_only - true if a SAML user should log into the cloud only with their third-party credentials and cannot log with OnApp login and password, otherwise false
system_email - system email address
system_host - server IP or URL
system_notification - true if system notifications are enabled, otherwise false
enable_notifications - true if notifications are enabled, otherwise false
ystem_support_email - customer service email address. By default, it is support@onapp.com, you can edit it in the on_app.yml file
system_theme - the global look and feel theme which is used for the whole cloud by default
pagination_max_items_limit - the maximum number of items after which the Show All option cannot be applied
app_name - application name displayed on the login screen
storage_unicast - true if the unicast mode is enabled, otherwise false
enable_daily_storage_report - true of the health check diagnostic pages are sent as email for each compute zone with storage daily, otherwise false
enable_hourly_storage_report - true if hourly storage reports are generated and sent. An hourly storage report is an email with details about storage disks changing degradation statuses (e.g. "Healthy" > "Degraded", "Missing members" > "Healthy", etc). If no such changes occurred during the last hour, the email is not sent
session_timeout - the timeout between sessions within OnApp in minutes
disable_plain_password_for_api - true if the option to use plain password and login for API access if disabled, otherwise false. By default, it is true
max_network_interface_port_speed - maximum NIC port speed in MB for the appliance network
nsx_polling_interval - polling interval for NSX environment
ssl_pem_path - Linux path to SSL certificate. By default, it is nil, which means disabled
use_yubikey_login - true if logging in using a Yubikey is enabled, otherwise false
yubikey_api_key - your Yubico secret key
yubikey_api_id - your Yubico client ID
localdomain - specify the domain for this VS. The default value is the localdomain. You can edit the default value for the domain in /onapp/interface/config/on_app.yml. This parameter is not applicable to Windows virtual servers
totp_enabled - true if TOTP authentication is enabled, otherwise false
rabbitmq_host - RabbitMQ server IP address
rabbitmq_vhost - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol
rabbitmq_login - RabbitMQ login 
rabbitmq_port - RabbitMQ port
rabbitmq_password - RabbitMQ password 
rabbitmq_continuation_timeout - timeout for client operations that expect a response (e.g. Bunny::Queue#get) in milliseconds. By default, it is 15000 ms.
allow_incremental_backups - true, if incremental backups are allowed, otherwise false. Incremental backups are not available for Windows virtual servers, as well as under VMware and Solid Fire.
use_ssh_file_transfer - set 1 to allow secure file access, transfer, and management to a remote server. It is not possible to utilize the SSH file transfer option when incremental backups are enabled.

Skip this option if you are using incremental backups.

If you are using the incremental backups option, you should either enable dedicated backup servers in your cloud or share the backups and templates folders (paths) between your compute resources.

ssh_file_transfer_server - the address of the remote server
ssh_file_transfer_user - the login used for remote server authentication. A password is not required, as it is required that you store a host key
ssh_file_transfer_options - SSH protocol options that set the rules and behavior of how to log into the remote server
ssh_port type - the port used for contacting SSH servers
ssh_timeout - secure shell timeout in seconds. By default, it is 10 seconds. If no response during this period, the ssh session will close
template_path - path to the directory where templates will be stored
backups_path - path to the directory where backups will be stored
data_path - path to the directory where the recovery templates will be stored
update_server_url - URL address where OnApp software updates are downloaded from
delete_template_source_after_install - true if the downloaded templates will be deleted after they are distributed, otherwise false
license_key - license key of your OnApp CP
generate_comment - this text is added by OnApp to system configuration files, such as resolv.conf
simultaneous_backups - the maximum allowed number of simultaneous compute resource and data store backup processes
simultaneous_backups_per_datastore - the maximum number of simultaneous data store backup processes
simultaneous_backups_per_hypervisor - the maximum number of simultaneous compute resource backup processes 
simultaneous_transactions - the number of transaction runners which the daemon will execute at the same time
simultaneous_storage_resync_transactions - the number of transaction runners which the storage will execute at the same time
simultaneous_personal_deliviries - the number of simultaneous transactions for sending messages from the notification center on the vCloud stats usage
simultaneous_vcenter_hypervisors_sync - the number of VMware compute resource synchronization executed at the same time (can be accessed in log/production_vcenter.log). By default, it is 1
guest_wait_time_before_destroy - the VS shutdown period (from 30 to 300 seconds). This allows refusing the shutdown if the VS is booting and retrying every 30 seconds till it is registered
remote_access_session_start_port - the first port in the range, which are used to remotely connect to virtual servers using the integrated VNC console
remote_access_session_last_port - the last port in the range, which are used to remotely connect to virtual servers using the integrated VNC console
ajax_power_update_time - how often VS status is refreshed on the Virtual Servers screen in milliseconds 
ajax_pagination_update_time - how often the dashboard, logs, and other items are refreshed in milliseconds 
ajax_log_update_interval - log output automatic refresh interval in milliseconds. By default, it is 5000 ms
hypervisor_live_times - determines how many times the Control Panel server will attempt to contact a compute resource before failover is initiated. 1 compute resource live time = 10 seconds
iso_path_on_cp - the location where ISO images are stored on the Control Panel server. By default, the location is /data. 
ova_path - the location where OVAs are downloaded/uploaded on the Control Panel server. By default, the location is data.
iso_path_on_hv - the location where ISOs are stored on the compute resources. By default, the location is /data
disable_hypervisor_failover - true if compute resource failover will not initiate after meeting the value of the hypervisor_live_times parameter, otherwise false
ips_allowed_for_login - list of IP addresses allowed for login to OnApp CP

Monitis came to its end of life on June 1st, 2019, and is no longer supported. 

monitis_path - path to the directory where Monitis client (to enable autoscale) will be installed
monitis_account - name of the Monitis account
monitis_apikey - API key to access the Monitis account
locales - an array of locals (the locale code) available for the users
max_memory_ratio - memory coefficient that indicates how you can increase the memory of Xen-based VS without hot resize. The default value is 16
kvm_max_memory_rate - default max memory rate that is used to calculate a max memory limit, by default it is 8
kvm_available_free_memory_percentage - the percentage that is used to calculate a max memory limit, by default it is 90%
default_image_template - default VS template to create a new virtual server
service_account_name - the service account name that will be automatically created on VMware virtual servers to be able to communicate with them
default_firewall_policy - default firewall policy for all VSs (unless set otherwise for a particular VS)
drop_firewall_policy_allowed_ips - enter the IP addresses to be allowed as an exception if the default firewall policy is DROP
show_ip_address_selection_for_new_vm - true if IP address assignment during VS creation is enabled, otherwise false
backup_taker_delay - frequency in seconds for launching the Backup Taker task
cluster_monitor_delay - frequency in seconds for launching the Cluster Monitor task
hypervisor_monitor_delay - frequency in seconds for launching the compute resource Monitor task
cdn_sync_delay - frequency in seconds for launching the CDN sync task
schedule_runner_delay - frequency in seconds for launching the Schedule Runner task
transaction_runner_delay - frequency in seconds for launching the Transaction Runner task
transaction_approvals - true if transaction approvals are enabled, otherwise false
billing_transaction_runner_delay - frequency in seconds for launching the Billing task
zombie_transaction_time - the duration in minutes for the system to consider a task as "pending" before it can be relegated to zombie status
zombie_disk_space_updater_delay - the duration in minutes for the system to check the size of a zombie disk
run_recipe_on_vs_sleep_seconds - period to sleep before running the recipe on a virtual server in seconds.By default, it is 10
dns_enabled - true if DNS is enabled, otherwise false
allow_start_vms_with_one_ip - true if it is allowed to start up virtual servers with one IP address, otherwise false
allow_initial_root_password_encryption - true if password encryption is allowed, otherwise set false
wipe_out_disk_on_destroy - true if the disk wipeout is allowed when deleting or migrating a disk, otherwise false
partition_align_offset - (default 2048) for newly built disk on SolidFire where your new partition starts from
password_enforce_complexity - true of password enforce complexity is enabled, otherwise false
password_minimum_length - the minimum required password length
password_upper_lowercase - true if the user is enforced to use both upper and lowercase letters in their password, otherwise false
password_letters_numbers - true if the user is enforced to use both letters and numbers in their password, otherwise false
password_symbols - true if the user is enforced to use symbols in their password, otherwise false
password_force_unique - true if the user is enforced to enter a unique password configuration each time they change the password, otherwise false. This refers to the user account passwords only
password_lockout_attempts - the number of unsuccessful login attempts that are allowed before the user's account is locked out
password_expiry - password expiry period in months
password_history_length - the number of last passwords saved in OnApp configuration
cloud_boot_enabled - true if CloudBoot system is enabled on the cloud, otherwise false
io_limiting_enabled - true if IOPS limiting is enabled, otherwise false 
nfs_root_ip - IP address of the NFS server where templates for creating PXE compute resources are stored
cloud_boot_target - IP of the server where the CP is installed
default_acceleration_policy - true if default acceleration policy is enabled, otherwise false
default_virsh_console_policy - true if Virsh console is available by default for all newly created VSs, otherwise false
force_shutdown_on_poweroff_failure - true 
if Virsh destroy is during system shutdown or reboot, otherwise false
number_of_notifications_to_show - number of notifications to show
notification_subject_prefix - the notification subject prefix
max_ip_addresses_to_assign_simultaneously - the maximum number of IP addresses that can be assigned to the user simultaneously. The default value is 256
wizard_resource_reservation_ttl - time to live of reserved data on VS wizard in seconds. By default, it is 10
storage_enabled - true if OnApp storage is enabled, otherwise false
prefer_local_reads - true if the local read path is enabled, otherwise false
intra_hypervisor_balance_threshold_ratio - percentage ratio to the average free space for all nodes in the hypervisor. The default value is 5%. You will receive a warning in the storage health check if the free space on one of the compute resource's nodes will be smaller by the indicated value as compared to the other nodes on the compute resource
inter_hypervisor_balance_threshold_ratio - percentage ratio to the average free space for all compute resources within one hypervisor zone. The default value is 5%. You will receive a warning in the storage health check if the free space on one of the compute resources in the zone will be smaller by the indicated value as compared to the other resources in the compute zone
uniform_node_capacity_threshold_ratio - the value (%) by which the size of a node in a data store can differ from the average node size in this data store. The default value is 5%. If this value is exceeded, you will receive a warning in the storage health check
allow_hypervisor_password_encryption - true if VMware compute resource password encryption is allowed, otherwise false
archive_stats_period - hourly statistics storage time set in months. For example, if you set that parameter to 10, the hourly statistics will be stored for the current month and the 10 previous months. And everything older than 10 months will be sent to the archive (that is converted into monthly statistics). If this parameter is set as 1, then you can view the detailed hourly statistics for both the current and the previous month
instant_stats_period - the number of days the instant (raw) statistics will be stored
is_archive_stats_enabled - true if the hourly statistics archiving is enabled otherwise false
disable_billing - true if billing is disabled, otherwise false
mysql_billing_transaction_retries - number of MySQL billing transaction retries if not successful. By default, it is 25
system_alert_reminder_period - 
the duration in minutes for the system to email alerts to admin if the failover resources are not enough. The default value is 60.
wrong_activated_logical_volume_alerts -
true, if wrong activated logical volume alerts are enabled, otherwise false. The default value is false
wrong_activated_logical_volume_minutes - 
the alert emails frequency in minutes
use_html5_vnc_console - true if the use of HTML 5 console is enabled otherwise false
storage_endpoint_override - override storage endpoint with a custom IP address. By default, it is empty.
url_for_custom_tools - path to custom recovery ISO images. Specify the full URL to the tools file packed with GNU Tar + Gzip, like http://domain.com/file.tgz
backup_convert_coefficient - the parameter is applicable only to incremental backups. During the backup conversion to a template, the backup’s size is multiplied by this coefficient to make sure that the template will be slightly bigger than the actual size for correct performance
rsync_option_xattrs - true if storing extended attributes is enabled when taking incremental backups, otherwise false
rsync_option_acls - true if storing access control lists is enabled, otherwise false
simultaneous_backups_per_backup_server - number of simultaneous backups per backup server. By default, it is 2
email_delivery_method - the delivery method for the gateway; it can be smtp or sendmail.

An array of parameters are used for the notification messages. They configure automatically on the CP and work locally. If want to redirect the notification messages, you can change smtp_address and/orsmtp_port:

  • smtp_address - you can change this parameter if you want to redirect
  • smtp_port - you can change this parameter if you want to redirect
  • smtp_domain - the associated domain
  • smtp_username - the username to login into SMTP server
  • smtp_password - the password to login into SMTP server
  • smtp_authentication - an authentication mechanism
  • smtp_enable_starttls_auto - true if the StartTLS extension is enabled, otherwise false 

snmptrap_addresses - a set of IPv4 addresses separated by a comma. These IP addresses will be used for communication between Control Panel and compute resources
snmptrap_port - port used for SNMP trap. This must be greater than 1024

We recommend that you do not change the default value.

In case you change the port value on your OnApp CP - the corresponding change of the port VM_STATUS_SNMP_PORT should be made for all Compute resources in /etc/onapp.conf file.  

infiniband_cloud_boot_enabled - true if InfiniBand boot is enabled, otherwise false. By default, it is false


As the name implies, traffic is filtered based on the expenditure of tokens. Tokens roughly correspond to bytes, with the additional constraint that each packet consumes some tokens, no matter how small it is. This reflects the fact that even a zero-sized packet occupies the link for some time. On creation, the TBF is stocked with tokens which correspond to the amount of traffic that can be burst in one go. Tokens arrive at a steady rate until the bucket is full.

If no tokens are available, packets are queued, up to a configured limit. The TBF now calculates the token deficit, and throttles until the first packet in the queue can be sent.

If it is not acceptable to burst out packets at maximum speed, a peakrate can be configured to limit the speed at which the bucket empties. This peakrate is implemented as a second TBF with a very small bucket so that it doesn't burst.

To achieve perfection, the second bucket may contain only a single packet, which leads to the earlier mentioned 1mbit/s limit.

This limit is caused by the fact that the kernel can only throttle for at minimum 1 'jiffy', which depends on HZ as 1/HZ. For perfect shaping, only a single packet can get sent per jiffy
- for HZ=100, this means 100 packets of on average 1000 bytes each, which roughly corresponds to 1mbit/s. 


Limit is the number of bytes that can be queued waiting for tokens to become available. You can also specify this the other way around by setting the latency parameter, which specifies the maximum amount of time a packet can sit in the TBF. The latter calculation takes into account the size of the bucket, the rate and possibly the peakrate (if set). These two parameters are mutually exclusive.


Also known as buffer or maxburst. Size of the bucket, in bytes. This is the maximum amount of bytes that tokens can be available for instantaneously. In general, larger shaping rates require a larger buffer. For 10mbit/s on Intel, you need at least a 10kbyte buffer if you want to reach your configured rate!

If your buffer is too small, packets may be dropped because more tokens arrive per timer tick than fit in your bucket. The minimum buffer size can be calculated by dividing the rate by HZ.

Token usage calculations are performed using a table which by default has a resolution of 8 packets. This resolution can be changed by specifying the cell size with the burst. For example, to specify a 6000-byte buffer with 16-byte cell size, set a burst of 6000/16. You will probably never have to set this. Must be an integral power of 2.


A zero-sized packet does not use zero bandwidth. For ethernet, no packet uses less than 64 bytes. The Minimum Packet Unit determines the minimal token usage (specified in bytes) for a packet. Defaults to zero.

See more at https://man7.org/linux/man-pages/man8/tc-tbf.8.html

tc_latency - limit is the number of bytes that can be queued waiting for tokens to become available
tc_burst - 
the maximum amount of bytes that tokens can be available for instantaneously
tc_mtu - 
maximum transportation unit size. The default value is 33000 B
ha_enabled - true if high availability option is enabled, otherwise false
dashboard_api_access_token - the Access token from OnApp Dashboard which is used to synchronize locations between OnApp CP and OnApp Dashboard
allow_connect_aws - true if AWS is connected to a cloud, otherwise false
federation_trusts_only_private - true if only the private federation zones for which you have a trust token are visible to you in the list of federated zones, otherwise false
maximum_pending_tasks - 
the maximum number of tasks that can wait in the queue to run
max_upload_size - maximum file size allowed for uploading (in bytes) from 0 (unlimited) to 2147483647 (2GB)
transaction_standby_period - the time which a transaction spends in the stand-by period. The default value is 30
vcenter_synchronization_schedule_period - time in seconds when the next vCenter hypervisor events will be scheduled to process. By default, it is 90
ip_history_keep_period - IP history retention period in months. By default, it is 6
log_cleanup_period - the period in days after which the logs delete from the database. By default, it is 90
log_cleanup_enabled - true if logs cleaning enables after the time period specified in the parameter above, otherwise false
log_level - log detalization level: debug, info, warn, error, and fatal. This parameter is available only for CPs in development mode. It is not displayed for Control Panels in staging or production modes. By default, this parameter is set to 'info'
cdn_max_results_per_get_page - the maximum number of results per page delivered when OnApp data is synchronized with Aflexi. The default value is 500
instance_packages_threshold_num - when the specified number is reached, instance packages are shown in list view in the virtual server creation wizard for easier instance package selection. The default value is 3
amount_of_service_instances - the number of system processes that perform the OnApp engine tasks simultaneously. Each of the system processes performs the task using a separate CPU core. The default value is 2. Currently, the maximum value is 12. If you input a value larger than 12, the number of system processes will still be 12
graceful_stop_timeout - if the OnApp Engine is stopped, running transactions will fail after the amount of time (seconds) indicated by this parameter. By default, this parameter is set to 300 seconds
allow_to_collect_errors - true if the Control Panel is allowed to collect, aggregate, encrypt and send crash reports, otherwise false. If this feature is enabled, the error list from your Control Panel will be sent to OnApp as a form of an encrypted API call. By default, this option is disabled
password_protection_for_deleting - true of confirmation of user deletion by means of a password is enabled, otherwise false. By default it is disabled
draas_enabled - true if DRaaS is enabled for the Cloud, otherwise false
draas_shadow_ssh_port - default port for SSH connection
draas_shadow_vpn_port - default port for VPN connection
draas_vpn_cidr_block - pool of IP addresses for VPN on DRaaS. It is by default
zabbix_host - the IP address of your Zabbix server
zabbix_url - the path to the Zabbix web-interface
zabbix_user - your Zabbix user
zabbix_password - your Zabbix password
ping_vms_before_init_failover - true if VSs are contacting before initiating failover for a particular compute resource, otherwise false. By default, it is enabled
vcloud_stats_level1_period - interval of statistic collection for vCloud compute resource in seconds. By default, it is 60.
vcloud_stats_level2_period - 
interval of statistic collection for vCloud virtual server (CPUs/ RAM/Disk usage) in seconds. By default, it is 180.
vcloud_prevent_idle_session_timeout - period of time in seconds when the connection to vCloud kept idle. By default, it is 600
block_size - the block size in MB for disks which is used when migrating disks to another data store. The default value is 8 MB
сloud_boot_domain_name_servers - start address for the distribution of IP addresses from the pool
enforce_redundancy - true if it is possible to create IS data stores only with the disks that are replicated between different compute resources (in one compute zone), otherwise false. In this case, disks will be created only when there are at least two compute resources in the cloud. If this option is disabled, it will be possible to create data stores with disks that are replicated on hard drives of the same compute resource. In this case, if the compute resource crashes, no failover for disks is possible.
dashboard_stats - an array of statistics, which is shown on the dashboard
migration_rate_limit - the maximum rate limit used for migrating the VS. The default value is 10 Mbps
simultaneous_migrations_per_hypervisor - the maximum amount of transactions that can be run simultaneously on the target compute resource when migrating a VS. The default value is 5. Applicable only to Migrate VS and Disks
allow_advanced_vs_management - true if the VS advanced configuration is enabled, otherwise false
support_help_email - support email to which the help requests will be sent from Control Panel > Help
ip_address_reservation_time - the duration in seconds during which the IP address will be reserved for a user and unavailable for other users. The default value is 60
recipe_tmp_dir - the temporary recipe directory where all recipe scripts (on Control Panel, compute resources, and virtual servers) are generated. The default value is tmp
enable_super_admin_permissions - true if a super admin feature is enabled, otherwise false
snmp_stats_level1_period - set the delay in seconds between executing the backup tasks which gather information about compute resources uptime and virtual servers' statuses
snmp_stats_level2_period - set the delay in seconds between executing the backup tasks which gather information about the disk usage, network usage, CPU usage statistics, and the list of virtual servers
snmp_stats_level3_period - set the delay in seconds between executing the backup tasks which generate the list of volume groups and logical volumes
vcenter_l1_stats_timeout - time before statistic collection for vCenter will fail by timeout in seconds. By default, it is 180
vcenter_l2_stats_timeout - time in seconds before statistic collection for vCenter VSs (CPU/Disk /Network usage) will fail by timeout (depends on the number of VSs). By default, it is 600
action_global_lock_expiration_timeout - number of minutes
action_global_lock_retry_delay - the 
number of seconds before next attempt. The default value is 10
isolated_license - true if the isolated license is used on the CP, otherwise false
pagination_dashboard_pages_limit - the maximum number of pages to list log items in the Activity Log section at the main Dashboard page
trusted_proxies -  an array of trusted proxies
default_timeout - the default timeout for running VCD-related operations that are not listed below
instantiate_vapp_template_timeout - the amount of time for composing a vApp template
power_on_timeout - the amount of time for starting up a powered-off virtual server
power_off_timeout - the amount of time for shutting down a powered-on virtual server
suspend_timeout - the amount of time for suspending a virtual server
reboot_timeout - the amount of time for rebooting a virtual server
undeploy_timeout - the amount of time for undeploying a vApp
create_edge_gateway_timeout - the amount of time for creating an edge gateway
compose_vapp_timeout - the amount of time for composing a vApp template
recompose_vapp_timeout - the amount of time for recomposing vApp
create_snapshot_timeout - the amount of time for creating a VS snapshot
create_vdc_timeout - the amount of time for creating a resource pool
capture_vapp_timeout - timeout during conversion vApp to catalog in seconds. By default, it is 300
create_vapp_template_timeout - amount of time for composing a vApp template
upload_vapp_template_timeout - the number of seconds for uploading a vApp template (before failing due to timeout). By default, it is 3600
reset_timeout type - the number of seconds to wait for the reset task on the VCD side if the timeout of the longest transaction has expired. By default, it is 600
shutdown_timeout -
the number of seconds to wait for shutdown task on the VCD side if the timeout of the longest transaction expired. By default, it is 600
unsuspend_timeout -
the number of seconds to wait for an unsuspend task on the VCD side if the timeout of the longest transaction expired. By default, it is 600
upload_media_timeout -
the number of seconds to wait for upload media task on the VCD side if the longest transaction timeout expires. By default, it is 3600.
enable_download_timeout -
 the number of seconds to wait for enableDownload action task on the VCD side if the longest transaction timeout expired. By default, it is 900
adapter_response_timeout -
the number of seconds to wait for API response. By default, it is 60
adapter_open_connection_timeout - 
period in seconds during which the connection is kept open. By default, it is 30
show_new_wizard - true
 if the user has access to the Beta wizard, otherwise false. By default, it is false
iscsi_port_availability_check_timeout - the number of seconds for connections that cannot be established or an idle timeout after timeout seconds. By default, it is 5
max_cpu_quota - custom max CPU quota limit available. The default value is 1000GHz
max_memory_quota - custom max memory limit available. The default value is 1000GB
global_white_list_ips - an array of IP addresses that are not restricted from logging into CP
(lightbulb)force_windows_auto_backups - true if force Windows auto-backup is enabled, otherwise false

Page History

v. 6.6 Edge 3

  • added the force_windows_auto_backups parameter

v. 6.6 Edge 1

  • added the force_shutdown_on_poweroff_failure parameter

v. 6.5 Edge 3

  • added the disable_plain_password_for_api parameter

v.6.4 Edge 1

  • added the totp_enabled parameter

v.6.2 Edge 1

  • added the enable_super_admin_permissions parameter

v. 6.1 Edge 2

  • added the default_virsh_console_policy parameter

v. 6.0

  • added the following parameters:
    • default_custom_theme
    • drop_firewall_policy_allowed_ips
    • default_acceleration_policy 
    • recipe_temporary_directory
    • session_timeout

v. 5.10

  • removed the enable_huge_pages parameter

v. 5.9

  • added the following parameters:
    • max_ip_addresses_to_assign_simultaneously
    • ip_address_reservation_time 
    • disable_billing parameter
    • transaction_approvals 

v. 5.8 

  • added the allow_advanced_vs_management parameter

v. 5.7

  • added the following parameters: 
    • support_help_email
    • intra_hypervisor_balance_threshold_ratio

    • inter_hypervisor_balance_threshold_ratio 

    • uniform_node_capacity_threshold_ratio 

    • pagination_dashboard_pages_limit

v. 5.6

  • added the isolated_license parameter
  • updated the following parameters:
    • simultaneous_migrations_per_hypervisor
    • migration_rate_limit

v. 5.4

  •  added the following parameters:
    • block_size
    • migration rate limit
    • simultaneous migrations per hypervisor
    • snmp_stats_level1_period
    • snmp_stats_level2_period
    • snmp_stats_level3_period
  • removed ip_range_limit parameter

v. 5.2

  • added the following parameters:
    • google_map_token
    • dashboard_stats

v. 5.0

  • added the following parameters:
    • log_level
    • graceful_stop_timeout

v. 4.2

  •  added the following parameters:
    • use_yubikey_login
    • yubikey_api_id
    • yubikey_api_key
    • allow_to_collect_errors
    • draas_enabled
    • zabbix_host 
    • zabbix_url 
    • zabbix_user 
    • zabbix_password 

v. 4.1

  • added the following parameters:
    • instance_packages_threshold_num
    • cdn_max_results_per_get_page
    • transaction_standby_period 
    • amount_of_service_instances

v. 3.5

  • added system_theme parameter

v. 3.3.1

  • added dashboard_api_access_token parameter

v. 3.3

  • added instant_stats_period  parameter

v. 3.2.2:

  • added the following parameters:
    • rsync_option_xattrs
    • rsync_option_acls

v. 3.2:

  • added the following parameters:
    • allow_incremental_backups
    • backup_convert_coefficient 
    •  url_for_custom_tools 

v. 3.1:

  • added the following parameters:
    • allow_start_vms_with_one_ip
    • archive_stats_period
    • is_archive_stats_enabled
    • service_account_name
    • system_alert_reminder_period
    • use_html5_vnc_console 
    • wrong_activated_logical_volume_minutes

v. 3.0 :

  • added the following parameters:
    • enable_huge_pages
    • use_nbd