Differences

This shows you the differences between two versions of the page.

--- guides:reference:settings [2022/10/10 14:33] – yspeerte
+++ guides:reference:settings [2024/07/03 12:31] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== Settings ======
+> <color orange>This article is under development  \\ Please refer to [[guides:reference:lookup_tweaks|Settings tweaks]] page for details on each Tweak variable</color>
+The NetYCE GUI makes a distinction between "General settings" and "Compliance settings". The distinction is just their scope and the database these settings are stored in. The backups and compliance settings are stored and maintained separate from all other settings.
+This is the result of using a dedicated database for the backup configurations and all compliance data. The settings that control the backup and compliance operation are stored in the same ''NCCM'' database. And, when restoring a "Backups archive", these settings are restored along with the data, policies and reports.
+The "General settings" apply to everything but the backups and compliance.
+This article describes ALL the settings and their use, regardless of their scope. Each description will clarify to which scope it applies the GUI page to set it.
+The various settings are grouped by type.
+^Class^Type^Scope^Variable^Description^Sample num-value^Sample str-value^
+|Tweaks|archives|General|[[guides:reference:lookup_tweaks#Archive_count_nccm]]|Maximum number of archives to maintain for NCCMdb archives. Default is 15|15| |
+|Tweaks|archives|General|[[guides:reference:lookup_tweaks#Archive_count_yce]]|Maximum number of archives to maintain for YCEdb archives. Default is 15|15| |
+|Tweaks|custom reports|General|[[guides:reference:lookup_tweaks#AllowCustomReportsDecrypt]]|Custom reports will decrypt passwords only for those user-levels present in String (eg: '456')| |456|
+|Tweaks|custom reports|General|[[guides:reference:lookup_tweaks#Email_report_body_limit]]|Emailed custom reports are truncated to "Numeric value" lines. Use "0" for none. Attached CSV file is never truncated|5| |
+|Tweaks|evpn|General|[[guides:reference:lookup_tweaks#Evpn_cores]]|A '%%|%%'-separated list of EVPN cores to choose from in the Evpn form| |asd-cr01%%|%%asd-cr002|
+|Tweaks|evpn|General|[[guides:reference:lookup_tweaks#Show_Evpn]]|If set to 1, evpn details get shown|0| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#AllowTemplateEdit]]|When number set <>0, editing of production template revision is allowed|1| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Allow_custom_device_types]]|When set to 1, users are allowed to add custom device types for the OS repository. When set to 0, they can only use values that already exist|0| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Change_hostname]]|When <> 0, a Hostname change is not restricted to its node-type function|0| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Default_site_status]]|Num_value defines the initial site status (1=active, 2=planned, 0=obsolete, ..)|2| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Filter_cmdb_nodes]]|Main Node grid will filter (hide) CMDB nodes when Num_val > 0|1| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Landing_page]]|Specifies the default landing page for the frontend: 'yce' or 'cmdb'.| |yce|
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Login_legal_message]]|You can set the num value of this tweak to 1 to display a legal message on the bottom of the login page. <br>It supports <b>html</b> tags.|0| |
+|Tweaks|gui|General|[[guides:reference:lookup_tweaks#Main_substring_search]]|Main Search will treat non-wildcard values as substring searches when Num_val > 0|1| |
+|Tweaks|gui spc|General|[[guides:reference:lookup_tweaks#Show_newsite_bkcode]]|List of Client_types for which the "BK-code" option will be shown (comma separated)|1|RN|
+|Tweaks|gui spc|General|[[guides:reference:lookup_tweaks#Show_newsite_rn2subnet]]|List of Client_types for which the "RN2 subnet" option will be shown (comma separated)|0|RN|
+|Tweaks|ipsec|General|[[guides:reference:lookup_tweaks#Ipsec_delete_full]]|Delete GRE tunnels alongside IPsec tunnels|1| |
+|Tweaks|ipsec|General|[[guides:reference:lookup_tweaks#Ipsec_first_free]]|The Site_id for a new IPsec tunnel|1| |
+|Tweaks|jobs|General|[[guides:reference:lookup_tweaks#Commit_pending_policy]]|When Num_value set to 1, commit based vendors will issue commit commands during command jobs: in case this is not desired set the Num_value to 0|1| |
+|Tweaks|jobs|General|[[guides:reference:lookup_tweaks#Sched_ignore_locks]]|Scheduler will not wait for jobs running on same node when Num_value > 0|0|-|
+|Tweaks|jobs|General|[[guides:reference:lookup_tweaks#Send_email_to]]|Set to 'user', 'group' or 'both'. When set to 'user' and user-email is blank, use group-email|0|Both|
+|Tweaks|jobs|General|[[guides:reference:lookup_tweaks#Use_hpc7_mgmt_vrf]]|Comware7 management VRF workaround|1|DC_CE|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_action_logs]]|do not keep Action_log entries older than Num_value days. Default = 400|365|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_config_logs]]|do not keep Config_log entries older than Num_value days. Default = 100|365|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_custom_reports]]|do not keep Custom reports older than Num_value days. Default = 30|30|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_nccm_data]]|do not keep NCCM entries older than Num_value days. Default = 800|800|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_node_logs]]|do not keep Node_log entries older than Num_value days. Default = 400|365|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_result_files]]|do not keep Job log files older than Num_value days. Default = 30|30|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_task_logs]]|do not keep Task_log entries older than Num_value days. Default = 100|365|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Age_temp_files]]|do not keep temp files older than Num_value days. Default = 15|15|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Export_action_logs]]|When number set to 1, the Action_logs (users) will be exported to log files|1|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Export_config_logs]]|When number set to 1, the Config_logs (jobs) will be exported to log files|1|-|
+|Tweaks|logs|General|[[guides:reference:lookup_tweaks#Export_task_logs]]|When number set to 1, the Task_logs (api) will be exported to log files|1|-|
+|Tweaks|nms spc|General|[[guides:reference:lookup_tweaks#SolarWinds_decomm_period]]|SolarWinds delayed delete period in days|7|-|
+|Tweaks|service-types|General|[[guides:reference:lookup_tweaks#Keep_unresolved_st_variables]]|Service_type variables that cannot be resolved will be not be set to blank values when Num <> 0|0|-|
+|Tweaks|service-types|General|[[guides:reference:lookup_tweaks#Remove_deleted_supernets]]|Supernets (v4/v6) will be deleted when number set <>0, rather than set 'free' for reuse or reservations. Deletes ALL currently 'free'|0|-|
+|Tweaks|service-types|General|[[guides:reference:lookup_tweaks#ServiceDeleteCheckTopo]]|When <> 0, the Delete Service will abort if topology exists to outside this service|0|-|
+|Tweaks|debug|General|[[guides:reference:lookup_tweaks#Debug_max_days]]|Maximum age in days before ending any NetYCE debug mode. Default = 1 day (24h), Forever = 0|1|-|
+|Tweaks|templates|General|[[guides:reference:lookup_tweaks#Template_markers]]|When Num_value equals 1 - print 'start' template; when 2 - also include 'done'; when 3 - also include 'resume'|3|<current_template> <current_vendor> <client_type>|
+|Tweaks|topology|General|[[guides:reference:lookup_tweaks#Allow_topo_multipoint]]|For Client_type in <String>, permit Service_type to add many topo links on a port when <Num> not 0|1|FP|
+|Tweaks|accounts|General|[[guides:reference:lookup_tweaks#Ldap_idle_account_age]]|When Num value > 0, idle LDAP accounts will be removed if the last-login date exceeds this many days. Default is 0, skipping idle aging|0|-|
+^ ^^^^^^^
+|Tweaks|cmpl|Compliance|Cmpl_batch_size|Maximum number of nodes the compliance process will pick up at once. Default = 1000|1000|-|
+|Tweaks|cmpl|Compliance|Cmpl_censor_config|Should compliance be run on censored (1), or uncensored (0) configs?|0| |
+|Tweaks|cmpl|Compliance|Cmpl_cmd_rule_update|Flag to signify a cmpl command rule check|0| |
+|Tweaks|cmpl|Compliance|Cmpl_default_report_type|The default report type for report templates (0-3)|1| |
+|Tweaks|cmpl|Compliance|Cmpl_node_limit|-|6000| |
+|Tweaks|cmpl|Compliance|Cmpl_policy_schedule_update|Flag to signify a cmpl policy schedule check without a config change|0| |
+|Tweaks|cmpl|Compliance|Cmpl_policy_update|Flag to signify a cmpl policy check without a config change|0| |
+|Tweaks|cmpl|Compliance|Default_signal_trigger|Default signal trigger: Non-compliant to Compliant|0|NC2C|
+|Tweaks|cmpl|Compliance|Default_signal_trigger|Default signal trigger: Non-compliant to Non-compliant|0|NC2NC|
+|Tweaks|cmpl|Compliance|Default_signal_trigger|Default signal trigger: Compliant to Compliant|0|C2C|
+|Tweaks|cmpl|Compliance|Default_signal_trigger|Default signal trigger: Compliant to Non-compliant|1|C2NC|
+|Tweaks|cmpl|Compliance|Default_signal_type|Default signal type|1|Trap|
+|Tweaks|nccm|Compliance|Delete_polling_group|Whenever you delete a polling group, 0: delete all its nodes from Nccm_selection or 1: delete only nodes that do not belong to a polling group anymore|1| |
+|Tweaks|nccm|Compliance|Nccm_batch_size|Maximum number of nodes the backup poller process will pick up at once. Default = 200|200|-|
+|Tweaks|nccm|Compliance|Nccm_max_age|Maximum age in days of a base-configuration. Set the Num_value. Default = 7|7|-|
+|Tweaks|nccm|Compliance|Nccm_max_diffs|Maximum number of stored config-diffs before a new base-config is created. Set Num_value. Default = 36|36|-|
+|Tweaks|nccm|Compliance|Nccm_max_diff_size|Maximum size in bytes of a config-diff before a new base-config is created. Set Num_value. Default = 8192|8192|-|
+|Tweaks|nccm|Compliance|Nccm_node_limit|Maximum number of nodes that will be polled for backups each cycle. Set Num_value. Default = 3000|3000|-|
+|Tweaks|nccm|Compliance|Nccm_stats|Set to 1 to collect statistics (in the file logs/yce_nccmd_stats.log) for the nccm daemon|0| |
+|Tweaks|nccm|Compliance|Nccm_truncate_length|When viewing a config in the NCCM the config is truncated at a default of 2000 lines|2000|-|
+|Tweaks|nccm|Compliance|Polling_interval_translations|Translations for polling intervals for polling groups, from hours to readable strings. Num_value is the default|24|%%1,1h|2,2h|4,4h|8,8h| 12,12h|24,1d|48,2d| 120,5d|168,1w| 336,2w|504,3w|672,4w%%|
+|Tweaks|cmpl|Compliance|Cmpl_max_children|Compliance max children|3|*|
+|Tweaks|cmpl|Compliance|Default_cmpl_rule_severity|Default severity for compliance rules (Medium)|1| |
+|Tweaks|nccm|Compliance|Nccm_max_children|Nccm deamon max children alive at the same time|3|*|
+|Tweaks|nccm|Compliance|Nccm_poll_interval|Nccm deamon poll cycle length|300|*|
+//