View System Configuration

To see all the system configuration settings, use the following request:

GET /settings/configuration.xml
GET /settings/configuration.json

XML Request Example

curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass --url http://onapp.test/settings/configuration.xml

JSON Request Example

curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url http://onapp.test/settings/configuration.json

XML Output Example

  <use_yubikey_login type="boolean">true</use_yubikey_login>
  <allow_incremental_backups type="boolean">true</allow_incremental_backups>
  <use_ssh_file_transfer type="boolean">true</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>
  <delete_template_source_after_install type="boolean">true</delete_template_source_after_install>
  <generate_comment># Automatically generated by OnApp (3.1.0)</generate_comment>
  <simultaneous_backups type="integer">1</simultaneous_backups>
  <simultaneous_backups_per_datastore type="integer">150</simultaneous_backups_per_datastore>
  <simultaneous_backups_per_hypervisor type="integer">2</simultaneous_backups_per_hypervisor>
  <simultaneous_transactions type="integer">10</simultaneous_transactions>
  <guest_wait_time_before_destroy type="integer">300</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">10000</ajax_power_update_time>
  <ajax_pagination_update_time type="integer">10000</ajax_pagination_update_time>
  <hypervisor_live_times type="integer">12</hypervisor_live_times>
  <remove_backups_on_destroy_vm type="boolean">true</remove_backups_on_destroy_vm>
  <disable_hypervisor_failover type="boolean">false</disable_hypervisor_failover>
  <locales type="array">
  <max_memory_ratio type="integer">16</max_memory_ratio>
  <remove_old_root_passwords type="boolean">false</remove_old_root_passwords>
  <pagination_max_items_limit type="integer">99</pagination_max_items_limit>
  <default_image_template type="integer">19</default_image_template>
  <app_name>DEV5 cloud</app_name>
  <show_ip_address_selection_for_new_vm type="boolean">true</show_ip_address_selection_for_new_vm>
  <backup_taker_delay type="integer">5</backup_taker_delay>
  <billing_stat_updater_delay type="integer">5</billing_stat_updater_delay>
  <cluster_monitor_delay type="integer">15</cluster_monitor_delay>
  <hypervisor_monitor_delay type="integer">5</hypervisor_monitor_delay>
  <cdn_sync_delay type="integer">1200</cdn_sync_delay>
  <dashboard_stats type="array">
  <schedule_runner_delay type="integer">5</schedule_runner_delay>
  <transaction_runner_delay type="integer">5</transaction_runner_delay>
  <zombie_transaction_time type="integer">180</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">true</dns_enabled>
  <enabled_libvirt_anti_spoofing type="boolean">true</enabled_libvirt_anti_spoofing>
  <allow_start_vms_with_one_ip type="boolean">true</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">6</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">1</password_lockout_attempts>
  <password_expiry type="integer">1</password_expiry>
  <password_history_length type="integer">12</password_history_length>
  <force_windows_backups type="boolean">false</force_windows_backups>
  <cloud_boot_enabled type="boolean">true</cloud_boot_enabled>
  <storage_enabled type="boolean">true</storage_enabled>
  <prefer_local_reads type="boolean">false</prefer_local_reads>
  <allow_hypervisor_password_encryption type="boolean">false</allow_hypervisor_password_encryption>
  <archive_stats_period type="integer">3</archive_stats_period>
  <instant_stats_period type="integer">10</instant_stats_period>
  <is_archive_stats_enabled type="boolean">true</is_archive_stats_enabled>
  <system_alert_reminder_period type="integer">60</system_alert_reminder_period>
  <use_html5_vnc_console type="boolean">true</use_html5_vnc_console>
  <storage_endpoint_override nil="true"/>
  <max_network_interface_port_speed type="integer">10000</max_network_interface_port_speed>
  <session_timeout type="integer">480</session_timeout>
  <backup_convert_coefficient type="float">1.1</backup_convert_coefficient>
  <rsync_option_xattrs type="boolean">false</rsync_option_xattrs>
  <rsync_option_acls type="boolean">true</rsync_option_acls>
  <simultaneous_backups_per_backup_server type="integer">3</simultaneous_backups_per_backup_server>
  <enable_hourly_storage_report type="boolean">false</enable_hourly_storage_report>
  <enable_daily_storage_report type="boolean">false</enable_daily_storage_report>
  <storage_unicast type="boolean">true</storage_unicast>
  <snmptrap_port type="integer">3162</snmptrap_port>
  <infiniband_cloud_boot_enabled type="boolean">false</infiniband_cloud_boot_enabled>
  <cdn_max_results_per_get_page type="integer">500</cdn_max_results_per_get_page>  
  <allow_to_collect_errors type="boolean">true</allow_to_collect_errors>
  <draas_enabled type="boolean">false</draas_enabled>
  <migration_rate_limit type="integer">10</migration_rate_limit>
  <simultaneous_migrations_per_hypervisor type="integer">5</simultaneous_migrations_per_hypervisor>
  <isolated_license type="boolean">true</isolated_license> 
  <allow_advanced_vs_management type="boolean">true</allow_advanced_vs_management>


use_yubikey_login - whether logging in using a Yubikey is enabled

yubikey_api_key - your Yubico secret key

yubikey_api_id - your Yubico client ID

use_ssh_file_transfer - set 1 to allow secure file access, transfer and management to a remote server. It is not possible to utilize SSH file transfer option when incremental backups are enabled.

Skip this option if you are using incremental backups.

If you are using 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 the port used for contacting SSH servers

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 - if enabled, the downloaded templates will be deleted after they are distributed

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

guest_wait_time_before_destroy – the VS shutdown period (from 30 to 300 seconds). This allows to refuse the shutdown if the VS is booting and retry 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

support_help_email - support email to which the help requests will be sent from Control Panel > Help

ajax_power_update_time - how often VS status is refreshed on the Virtual Servers screen in ms

ajax_pagination_update_time - how often the dashboard, logs and other items are refreshed in 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

recovery_templates_path - path to the directory where recovery templates will be stored

remove_backups_on_destroy_vm - set 1 to remove all VS backups after this VS was deleted

disable_hypervisor_failover - 1, if compute resource failover will not initiate after meeting the value of the hypervisor_live_times parameter

disable_billing - true, if billing is disabled, otherwise false

ips_allowed_for_login - list of IP addresses allowed for login to OnApp CP

Note that Monitis will come to its end of life on June 1st, 2019 and will no longer be 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

remove_old_root_passwords - 1, if old root password is removed, otherwise 0

pagination_max_items_limit – the maximum number of items after which the Show All option cannot be applied.

pagination_dashboard_pages_limit – the maximum number of pages to list log items in the Activity Log section at the main Dashboard page.

allow_advanced_vs_management - true, if the VS advanced configuration is enabled, otherwise, false

default_image_template - default VS template to create a new virtual server

service account name - service account name that is automatically created on VMware virtual servers to be able to communicate with them. 

default_acceleration_policy - true, if default acceleration policy is enabled, otherwise, false

(lightbulb) default_virsh_console_policy - true, if Virsh console is available by default for all newly created VSs, otherwise, false

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

app_name - application name displayed on the login screen

show_ip_address_selection_for_new_vm - set 1 to enable IP address assignment during VS creation

transaction_approvals - true, if transaction approvals are enabled, otherwise, false

backup_taker_delay - frequency in seconds for launching the Backup Taker task

billing_stat_updater_delay - frequency in seconds for launching the Billing Stats Monitor 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

google_map_token - add Google API key, if you face the problem with viewing the maps on VS/Smart/Application server creation wizard.

dashboard_stats -  an array of statistics, which is shown on the dashboard

schedule_runner_delay - frequency in seconds for launching the Schedule Runner task

transaction_runner_delay - frequency in seconds for launching the Transaction Runner 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

dns_enabled – 1, if DNS is enabled, otherwise 0

enabled_libvirt_anti_spoofing - 1, if the anti-spoofing protection is enabled, otherwise 0

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 - set 1 to allow password encryption, otherwise set 0

allow_hypervisor_password_encryption - set 1 to allow VMware compute resource password encryption, otherwise set 0

wipe_out_disk_on_destroy – 1, if the disk wipeout is allowed when deleting or migrating a disk, otherwise 0

password_minimum_length type - the minimum required password length

password_letters_numbers - 1, if the user is enforced to use both letters and numbers in their password, otherwise 0

password_symbols type - 1, if the user is enforced to use symbols in their password, otherwise 0

password_force_unique - 1, if the user is enforced to enter unique password configuration each time they change the password, otherwise 0. This refers to the user account passwords only.

password_lockout_attempts - the number of unsuccessful logon attempts that are allowed before user's account is locked out

password_lockout_response - the message displayed to the user after theexceed the number of unsuccessful logon attempts

password_expiry type - password expiry period in months

password_history_length - the number of last passwords saved in OnApp configuration

force_windows_backups - 1, if forced backup feature is enabled for Windows-based virtual servers, otherwise 0

cloud_boot_enabled - 1, if CloudBoot system is enabled on the cloud, otherwise 0

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

max_ip_addresses_to_assign_simultaneously - the maximum number of IP addresses that can be assigned to user simultaneously. The default value is 256.

storage_enabled - true, if OnApp storage 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_ratiothe 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.

prefer_local_reads - true, if the local read path is enabled, otherwise false

vmware_cluster_name - name of the VMware cluster

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.

license_key - license key of your OnApp CP

isolated_license - true, if the isolated license is used on the CP, 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 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

use_html5_vnc_console - true, if the use of HTML 5 console is enabled, otherwise false

NOTE: It is only possible to use HTML 5 console if the Control Panel server is based on CentOS6.

backup_convert_coefficient - the parameter is applicable only to incremental backups. During the backup conversion to template, backup’s size is multiplied by this coefficient to make sure that template will be slightly bigger than the actual size for correct performance.

session_timeout - the timeout between sessions within OnApp in minutes

(lightbulb)enable_super_admin_permissions - true, if a super admin feature is enabled; otherwise, false

url_for_custom_tools - path to custom recovery ISO images. Specify the full URL to the tools file packed with GNU Tar + Gzip, like

snmptrap_addresses* - a set of IPv4 addresses separated by coma. These IP addresses will be used for communication between Control Panel and compute resources

snmptrap_port* - port used for snmptrap. This must be greater than 1024

We recommend that you do not to 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.  

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.

rsync_option_xattrs - true if storing extended attributes is enabled when taking incremental backups.

rsync_option_acls - true if storing access control lists is enabled.

dashboard_api_access_token - the Access token from OnApp Dashboard which  is used to synchronize locations between OnApp CP and OnApp Dashboard.

system_theme - the global look and feel theme which is used for the whole cloud by default.

cdn_max_results_per_get_page - the maximum number of results per page delivered when OnApp data are 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.

transaction_standby_period - the time which a transaction spends in stand-by period. The default value is 30.

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 in a form of an encrypted API call. By default, this option is disabled.

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'.

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.

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. 

draas_enabled - 'true' if DRaaS is enabled for the Cloud; otherwise false

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

enable_hourly_storage_report - generate and send hourly Storage reports. 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.

enable_daily_storage_report - are the health check diagnostic pages sent as email for each Compute zone with storage. 

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 process will still be 12.

migration_rate_limit –  the maximum rate limit used for migrating the VS. The default value is 10 Mbps.

recipe_temporary_directory - the temporary recipe directory where all recipe scripts (on Control Panel, compute resources and virtual servers) are generated. The default value is /tmp. 

simultaneous_migrations_per_hypervisor - the maximum amount of transactions which 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.

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

Page History

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

  • removed the following parameters:
    • system_email

    • system_host

    • system_notification

    • system_support_email

    • email_delivery_method smtp_address

    • smtp_authentication

    • smtp_domain

    • smtp_enable_starttls_auto

    • smtp_password

    • smtp_port

    • smtp_username

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 
  • removed wrong_activated_logical_volume_minutes parameter

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