Edit System Configuration

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

PUT /settings.xml
PUT /settings.json

XML Request example:

curl
 -i -X PUT http://onapp.test/settings.xml?restart=1 -d 
'<configuration><rsync_option_xattrs>false</rsync_option_xattrs><rsync_option_acls>true</rsync_option_acls><allow_incremental_backups>false</allow_incremental_backups><use_ssh_file_transfer>true</use_ssh_file_transfer><ssh_file_transfer_server>109.123.105.162</ssh_file_transfer_server><ssh_file_transfer_user>root</ssh_file_transfer_user><ssh_file_transfer_options>-oStrictHostKeyChecking=no-oUserKnownHostsFile=/dev/null-oPasswordAuthentication=no</ssh_file_transfer_options><ssh_port>22</ssh_port><template_path>/onapp/templates</template_path><backups_path>/onapp/backups</backups_path><data_path>/onapp/data</data_path><update_server_url>http://repo.onapp.com/</update_server_url><generate_comment>#AutomaticallygeneratedbyOnApp(3.0.GA)</generate_comment><simultaneous_backups>2</simultaneous_backups><simultaneous_backups_per_datastore>2</simultaneous_backups_per_datastore><simultaneous_backups_per_hypervisor>1</simultaneous_backups_per_hypervisor><simultaneous_transactions>16</simultaneous_transactions>
<simultaneous_backups_per_backup_server type="integer">2</simultaneous_backups_per_backup_server>
<guest_wait_time_before_destroy>55</guest_wait_time_before_destroy><remote_access_session_start_port>30000</remote_access_session_start_port><remote_access_session_last_port>30099</remote_access_session_last_port><system_email>app@onapp.com</system_email><ajax_power_update_time>8000</ajax_power_update_time><ajax_pagination_update_time>9000</ajax_pagination_update_time><hypervisor_live_times>12</hypervisor_live_times><enable_huge_pages>false</enable_huge_pages><system_host>onapp.com</system_host><system_notification>true</system_notification><system_support_email>support@onapp.com</system_support_email><recovery_templates_path>/onapp/tools/recovery</recovery_templates_path><remove_backups_on_destroy_vm>true</remove_backups_on_destroy_vm><disable_hypervisor_failover>false</disable_hypervisor_failover><ips_allowed_for_login></ips_allowed_for_login><monitis_path>/usr/local/monitis</monitis_path><monitis_account>monitis@onapp.com</monitis_account><monitis_apikey>4JIA5DJUM9O01HJ550B88V73GR</monitis_apikey><locales></locales><locales>en</locales><max_memory_ratio>16</max_memory_ratio><pagination_max_items_limit>100</pagination_max_items_limit><default_image_template>1</default_image_template><service_account_name>onapp</service_account_name><default_firewall_policy>DROP</default_firewall_policy><app_name>OnApp</app_name><show_ip_address_selection_for_new_vm>true</show_ip_address_selection_for_new_vm><backup_taker_delay>5</backup_taker_delay><billing_stat_updater_delay>5</billing_stat_updater_delay><cluster_monitor_delay>15</cluster_monitor_delay><hypervisor_monitor_delay>5</hypervisor_monitor_delay><cdn_sync_delay>1200</cdn_sync_delay><schedule_runner_delay>5</schedule_runner_delay><transaction_runner_delay>5</transaction_runner_delay><zombie_transaction_time>20</zombie_transaction_time><zombie_disk_space_updater_delay>300</zombie_disk_space_updater_delay><enabled_libvirt_anti_spoofing>true</enabled_libvirt_anti_spoofing><allow_start_vms_with_one_ip>false</allow_start_vms_with_one_ip><ip_range_limit>1000</ip_range_limit><allow_initial_root_password_encryption>false</allow_initial_root_password_encryption><wipe_out_disk_on_destroy>false</wipe_out_disk_on_destroy><password_enforce_complexity>false</password_enforce_complexity><password_minimum_length>6</password_minimum_length><password_upper_lowercase>false</password_upper_lowercase><password_letters_numbers>false</password_letters_numbers><password_symbols>false</password_symbols><password_force_unique>false</password_force_unique><password_lockout_attempts>3</password_lockout_attempts><password_expiry>1</password_expiry><password_history_length>12</password_history_length><force_windows_backups>false</force_windows_backups><cloud_boot_enabled>false</cloud_boot_enabled><nfs_root_ip>192.168.1.1</nfs_root_ip><cloud_boot_target>192.168.1.1</cloud_boot_target><storage_enabled>false</storage_enabled><prefer_local_reads>false</prefer_local_reads><vmware_cluster_name>OnApp</vmware_cluster_name><allow__hypervisor_password_encryption>false</allow_hypervisor_password_encryption><archive_stats_period>7776000</archive_stats_period><instant_stats_period>10</instant_stats_period><is_archive_stats_enabled>false</is_archive_stats_enabled><system_alert_reminder_period>60</system_alert_reminder_period><use_html5_vnc_console>false</use_html5_vnc_console><backup_convert_coefficient>1.1</backup_convert_coefficient><delete_template_source_after_install>1</delete_template_source_after_install><email_delivery_method>sendmail</email_delivery_method><instant_stats_period>10</instant_stats_period><smtp_address>smtp.gmail.com</smtp_address><smtp_authentication>login</smtp_authentication><smtp_domain>smtp.gmail.com</smtp_domain><smtp_enable_starttls_auto>1</smtp_enable_starttls_auto><smtp_password>pass</smtp_password><smtp_port>465</smtp_port><smtp_username>name</smtp_username><snmptrap_addresses>111.111.111.111</snmptrap_addresses><snmptrap_port>3162</snmptrap_port><url_for_custom_tools>www.sample.com</url_for_custom_tools><license_key>XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX</license_key><dashboard_api_access_token>fgfhhkkoopjjhjggdfg</dashboard_api_access_token><cdn_max_results_per_get_page type="integer">500</cdn_max_results_per_get_page><instance_types_threshold_num>6</instance_types_threshold_num><transaction_standby_period>30</transaction_standby_period><amount_of_service_instances>1</amount_of_service_instances><system_theme>dark</system_theme></configuration>' -u user:userpass -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request example

curl -i -X PUT http://onapp.test/settings.json?restart=1 -d 
'{"configuration":{"archive_stats_period": 33,"instant_stats_period": 103,"is_archive_stats_enabled": true,"rsync_option_xattr":true,"rsync_option_acls": false,"allow_incremental_backups": false,"use_ssh_file_transfer":true,"ssh_file_transfer_server":"109.123.105.162","ssh_file_transfer_user":"root","ssh_file_transfer_options":"-o
 StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o 
PasswordAuthentication=no","ssh_port":22,"template_path":"/onapp/templates","backups_path":"/onapp/backups","data_path":"/onapp/data","update_server_url":"http://repo.onapp.com/","license_key":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX","generate_comment":"#
 Automatically generated by OnApp (3.0.GA)","simultaneous_backups":2,"simultaneous_backups_per_datastore":2,"simultaneous_backups_per_hypervisor":1,"simultaneous_transactions":16,"simultaneous_backups_per_backup_server":2,"guest_wait_time_before_destroy":55,"remote_access_session_start_port":30000,"remote_access_session_last_port":30099,"system_email":"app@onapp.com","ajax_power_update_time":8000,"ajax_pagination_update_time":9000,"hypervisor_live_times":12,"enable_huge_pages":false,"system_host":"onapp.com","system_notification":true,"system_support_email":"support@onapp.com","recovery_templates_path":"/onapp/tools/recovery","remove_backups_on_destroy_vm":true,"disable_hypervisor_failover":false,"ips_allowed_for_login":"","monitis_path":"/usr/local/monitis","monitis_account":"monitis@onapp.com","monitis_apikey":"4JIA5DJUM9O01HJ550B88V73GR","locales":["","en"],"max_memory_ratio":16,"pagination_max_items_limit":100,"default_image_template":"1","service_account_name":"onapp","default_firewall_policy":"DROP","app_name":"OnApp","show_ip_address_selection_for_new_vm":true,"backup_taker_delay":5,"billing_stat_updater_delay":5,"cluster_monitor_delay":15,"hypervisor_monitor_delay":5,"cdn_sync_delay":1200,"schedule_runner_delay":5,"transaction_runner_delay":5,"zombie_transaction_time":"20","zombie_disk_space_updater_delay":300,"enabled_libvirt_anti_spoofing":true,"allow_start_vms_with_one_ip":false,"ip_range_limit":1000,"allow_initial_root_password_encryption":false,"wipe_out_disk_on_destroy":false,"password_enforce_complexity":false,"password_minimum_length":6,"password_upper_lowercase":false,"password_letters_numbers":false,"password_symbols":false,"password_force_unique":false,"password_lockout_attempts":"3","password_expiry":1,"password_history_length":12,"force_windows_backups":false,"cloud_boot_enabled":false,"nfs_root_ip":"192.168.1.1","cloud_boot_target":"192.168.1.1","storage_enabled":false,"prefer_local_reads":false,"vmware_cluster_name":"OnApp","allow_hypervisor_password_encryption":false,"archive_stats_period":7776000,"is_archive_stats_enabled":false,"system_alert_reminder_period":60,"use_html5_vnc_console":false,"backup_convert_coefficient":"1.1","instant_stats_period":10,"email_delivery_method":sendmail,"smtp_address":smtp.gmail.com,"smtp_authentication":login,"smtp_domain":smtp.gmail.com,"smtp_enable_starttls_auto":1,"smtp_password":pass,"smtp_port":465,"smtp_username":name,"snmptrap_addresses":111.111.111.111,"snmptrap_port":3162,"delete_template_source_after_install":1,"url_for_custom_tools":"www.sample.com","system_theme":"dark","dashboard_api_access_token":"dfgdfghjhjjkjkljl", "cdn_max_results_per_get_page":500,"instance_types_threshold_num":6,"transaction_standby_period":30,"amount_of_service_instances":30}}' -u user:userpass -H 'Accept: application/json' -H 'Content-type: application/json' 

Where you can edit:

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.

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

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_backups_per_backup_server - the maximum number of simultaneous backup processes per backup server

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

system_email - the email address from which help requests and email alerts are sent

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

enable_huge_pages - true, if hugepages are enabled, otherwise false. Huge pages are the memory pages of size 2MB. Use of hugepages allows to reduce the number of page walks as compared to a standard method of translation from a virtual address to physical 4kB page.

system_host –the system host server IP or URL; email alerts link to transaction logs for alert events, and those logs are opened from the server configured here

system_notification - set 1 to enable email alerts

system_support_email - the email address to which the system will send alerts about failed transactions and change of compute resource status

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 compute resource_live_times parameter

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

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 are removed, otherwise 0

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

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_firewall_policy - default firewall policy for all VSs (unless set otherwise for a particular VS)

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

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

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

ip_range_limit - the number of IPs that can be added as a range at the same time

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  - specify minimum required password length (0-99). The default value is 6.

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 they exceed 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

storage_enabled - true, if OnApp storage is enabled, otherwise false

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

vmware_cluster_name - name of the VMware cluster

license_key - license key of your OnApp CP

archive_stats_period - set the time in months for hourly statistics storage

instant_stats_period - set the number of days the instant (raw) statistics will be stored

is_archive_stats_enabled - set this parameter true to enable archiving of hourly statistics; if false - the statistics will be archived on monthly basis

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

backup_convert_coefficient - This parameter is for incremental backups only. 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.

email_delivery_method - delivery method: either SNMPT or Sendmail 

smtp_address - address of the SMTP server

smtp_authentication -  select an authentication mechanism: login, plain, or cram_md5

smtp_domain - enter associated domain

smtp_enable_starttls_auto - enable or disable StartTLS extension

smtp_password - password to login into SMTP server 

smtp_port - port of the SMTP server

smtp_username -  user name to login into SMTP server

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

system_theme - specify the look and feel theme which should be used in the cloud by default. You can set dark or light parameters.

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.

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 used to synchronize locations between OnApp CP and OnApp Dashboard.

  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_types_threshold_num - when the specified number is reached, instance types are shown in list view in the virtual server creation wizard for easier instance type selection. The default value is 3.

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

 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 1. Currently, the maximum value is 5. If you input a value larger than five, the number of system process will still be five.

Page history

 v. 4.1

 Added the following parameters:

• instance_types_threshold_num
• cdn_max_results_per_get_page
• transaction_standby_period 
• amount_of_service_instances
  

v. 3.5

 Added the following parameter:

• system_theme

v. 3.3.1

 Added the following parameter:

• dashboard_api_access_token

v. 3.3

 Added the following parameter:

• delete_template_source_after_install

• instant_stats_period

• email_delivery_method

• smtp_address

• smtp_authentication

• smtp_domain

• smtp_enable_starttls_auto

• smtp_password

• smtp_port

• smtp_username

• snmptrap_addresses
• snmptrap_port

cpu_guarantee parameter was removed from general system settings and now can be set for a compute zone

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:

• 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 :

• enable_huge_pages
• use_nbd