'help'=>'Users will be deleted from LibreNMS after this may days of not logging in. 0 means never and users will be recreated if the user logs back in.',
],
],
'addhost_alwayscheckip'=>[
'description'=>'Check for duplicate IP when adding devices',
'help'=>'If a host is added as an ip address it is checked to ensure the ip is not already present. If the ip is present the host is not added. If host is added by hostname this check is not performed. If the setting is true hostnames are resolved and the check is also performed. This helps prevents accidental duplicate hosts.',
],
'alert_rule'=>[
'severity'=>[
'description'=>'Severity',
'help'=>'Severity for an Alert',
],
'max_alerts'=>[
'description'=>'Max Alerts',
'help'=>'Count of Alerts to be sent',
],
'delay'=>[
'description'=>'Delay',
'help'=>'Delay before an Alert will be sent',
],
'interval'=>[
'description'=>'Interval',
'help'=>'Interval to be checked for this Alert',
],
'mute_alerts'=>[
'description'=>'Mute Alerts',
'help'=>'Should Alert only be seen in WebUI',
],
'invert_rule_match'=>[
'description'=>'Invert Rule Match',
'help'=>'Alert only if rule doesn\'t match',
],
'recovery_alerts'=>[
'description'=>'Recovery Alerts',
'help'=>'Notify if Alert recovers',
],
'invert_map'=>[
'description'=>'All devices except in list',
'help'=>'Alert only for Devices which are not listed',
],
],
'alert'=>[
'ack_until_clear'=>[
'description'=>'Default acknowledge until alert clears option',
'help'=>'Default acknowledge until alert clears',
],
'admins'=>[
'description'=>'Issue alerts to admins',
'help'=>'Alert administrators',
],
'default_copy'=>[
'description'=>'Copy all email alerts to default contact',
'help'=>'Copy all email alerts to default contact',
],
'default_if_none'=>[
'description'=>'cannot set in webui?',
'help'=>'Send mail to default contact if no other contacts are found',
],
'default_mail'=>[
'description'=>'Default contact',
'help'=>'The default mail contact',
],
'default_only'=>[
'description'=>'Send alerts to default contact only',
'help'=>'Only alert default mail contact',
],
'disable'=>[
'description'=>'Disable alerting',
'help'=>'Stop alerts being generated',
],
'fixed-contacts'=>[
'description'=>'Updates to contact email addresses not honored',
'help'=>'If TRUE any changes to sysContact or users emails will not be honoured whilst alert is active',
'help'=>'Temporarily stores LDAP query results. Improves speeds, but the data may be stale.',
],
'auth_ldap_debug'=>[
'description'=>'Show debug',
'help'=>'Shows debug information. May expose private information, do not leave enabled.',
],
'auth_ldap_emailattr'=>[
'description'=>'Mail attribute',
],
'auth_ldap_group'=>[
'description'=>'Access group DN',
'help'=>'Distinguished name for a group to give normal level access. Example: cn=groupname,ou=groups,dc=example,dc=com',
],
'auth_ldap_groupbase'=>[
'description'=>'Group base DN',
'help'=>'Distinguished name to search for groups Example: ou=group,dc=example,dc=com',
],
'auth_ldap_groupmemberattr'=>[
'description'=>'Group member attribute',
],
'auth_ldap_groupmembertype'=>[
'description'=>'Find group members by',
'options'=>[
'username'=>'Username',
'fulldn'=>'Full DN (using prefix and suffix)',
'puredn'=>'DN Search (search using uid attribute)',
],
],
'auth_ldap_groups'=>[
'description'=>'Group access',
'help'=>'Define groups that have access and level',
],
'auth_ldap_port'=>[
'description'=>'LDAP port',
'help'=>'Port to connect to servers on. For LDAP it should be 389, for LDAPS it should be 636',
],
'auth_ldap_prefix'=>[
'description'=>'User prefix',
'help'=>'Used to turn a username into a distinguished name',
],
'auth_ldap_server'=>[
'description'=>'LDAP Server(s)',
'help'=>'Set server(s), space separated. Prefix with ldaps:// for ssl',
],
'auth_ldap_starttls'=>[
'description'=>'Use STARTTLS',
'help'=>'Use STARTTLS to secure the connection. Alternative to LDAPS.',
'options'=>[
'disabled'=>'Disabled',
'optional'=>'Optional',
'required'=>'Required',
],
],
'auth_ldap_suffix'=>[
'description'=>'User suffix',
'help'=>'Used to turn a username into a distinguished name',
],
'auth_ldap_timeout'=>[
'description'=>'Connection timeout',
'help'=>'If one or more servers are unresponsive, higher timeouts will cause slow access. To low may cause connection failures in some cases',
],
'auth_ldap_uid_attribute'=>[
'description'=>'Unique ID attribute',
'help'=>'LDAP attribute to use to identify users, must be numeric',
],
'auth_ldap_userdn'=>[
'description'=>'Use full user DN',
'help'=>"Uses a user's full DN as the value of the member attribute in a group instead of member: username using the prefix and suffix. (it’s member: uid=username,ou=groups,dc=domain,dc=com)",
],
'auth_ldap_wildcard_ou'=>[
'description'=>'Wildcard user OU',
'help'=>'Search for user matching user name independently of OU set in user suffix. Useful if your users are in different OU. Bind username, if set, still user suffix',
],
'auth_ldap_version'=>[
'description'=>'LDAP version',
'help'=>'LDAP version to use to talk to the server. Usually this should be v3',
'options'=>[
'2'=>'2',
'3'=>'3',
],
],
'auth_mechanism'=>[
'description'=>'Authorization Method (Caution!)',
'help'=>"Authorization method. Caution, you may lose the ability to log in. You can override this back to mysql by setting \$config['auth_mechanism'] = 'mysql'; in your config.php",
'help'=>'Ports of the listed description type(s) will be shown under the peering ports menu entry. See Interface Description Parsing docs for more info.',
],
'transit_descr'=>[
'description'=>'Transit Port Types',
'help'=>'Ports of the listed description type(s) will be shown under the transit ports menu entry. See Interface Description Parsing docs for more info.',
],
'core_descr'=>[
'description'=>'Core Port Types',
'help'=>'Ports of the listed description type(s) will be shown under the core ports menu entry. See Interface Description Parsing docs for more info.',
],
'customers_descr'=>[
'description'=>'Customer Port Types',
'help'=>'Ports of the listed description type(s) will be shown under the customers ports menu entry. See Interface Description Parsing docs for more info.',
'help'=>'This should *only* be set if you want to *force* a particular hostname/port. It will prevent the web interface being usable form any other hostname',
'help'=>'Enable distributed polling system wide. This is intended for load sharing, not remote polling. You must read the documentation for steps to enable: https://docs.librenms.org/Extensions/Distributed-Poller/',
'help'=>'Override the base uri in the case you have modified the Graylog default.',
],
'device-page'=>[
'loglevel'=>[
'description'=>'Device Overview Log Level',
'help'=>'Sets the maximum log level shown on the device overview page.',
],
'rowCount'=>[
'description'=>'Device Overview Row Count',
'help'=>'Sets the number of rows show on the device overview page.',
],
],
'password'=>[
'description'=>'Password',
'help'=>'Password for accessing Graylog API.',
],
'port'=>[
'description'=>'Port',
'help'=>'The port used to access the Graylog API. If none give, it will be 80 for http and 443 for https.',
],
'server'=>[
'description'=>'Server',
'help'=>'The ip or hostname of the Graylog server API endpoint.',
],
'timezone'=>[
'description'=>'Display Timezone',
'help'=>'Graylog times are stored in GMT, this setting will change the displayed timezone. The value must be a valid PHP timezone.',
],
'username'=>[
'description'=>'Username',
'help'=>'Username for accessing the Graylog API.',
],
'version'=>[
'description'=>'Version',
'help'=>'This is used to automatically create the base_uri for the Graylog API. If you have modified the API uri from the default, set this to other and specify your base_uri.',
'help'=>'This domain is used for network auto-discovery and other processes. LibreNMS will attempt to append it to unqualified hostnames.',
],
'network_map_show_on_worldmap'=>[
'description'=>'Display network links on the map',
'help'=>'Show the networks links between the different location on the worldmap (weathermap-like)',
],
'nfsen_enable'=>[
'description'=>'Enable NfSen',
'help'=>'Enable Integration with NfSen',
],
'nfsen_rrds'=>[
'description'=>'NfSen RRD Directories',
'help'=>'This value specifies where your NFSen RRD files are located.',
],
'nfsen_subdirlayout'=>[
'description'=>'Set NfSen subdir layout',
'help'=>'This must match the subdir layout you have set in NfSen. 1 is the default.',
],
'nfsen_last_max'=>[
'description'=>'Last Max',
],
'nfsen_top_max'=>[
'description'=>'Top Max',
'help'=>'Max topN value for stats',
],
'nfsen_top_N'=>[
'description'=>'Top N',
],
'nfsen_top_default'=>[
'description'=>'Default Top N',
],
'nfsen_stat_default'=>[
'description'=>'Default Stat',
],
'nfsen_order_default'=>[
'description'=>'Default Order',
],
'nfsen_last_default'=>[
'description'=>'Default Last',
],
'nfsen_lasts'=>[
'description'=>'Default Last Options',
],
'nfsen_split_char'=>[
'description'=>'Split Char',
'help'=>'This value tells us what to replace the full stops `.` in the devices hostname with. Usually: `_`',
],
'nfsen_suffix'=>[
'description'=>'File name suffix',
'help'=>'This is a very important bit as device names in NfSen are limited to 21 characters. This means full domain names for devices can be very problematic to squeeze in, so therefor this chunk is usually removed.',
],
'nmap'=>[
'description'=>'Path to nmap',
],
'opentsdb'=>[
'enable'=>[
'description'=>'Enable',
'help'=>'Exports metrics to OpenTSDB',
],
'host'=>[
'description'=>'Server',
'help'=>'The IP or hostname of the OpenTSDB server to send data to',
],
'port'=>[
'description'=>'Port',
'help'=>'The port to use to connect to the OpenTSDB server',
],
],
'own_hostname'=>[
'description'=>'LibreNMS hostname',
'help'=>'Should be set to the hostname/ip the librenms server is added as',
'help'=>'Do not backup the listed OS with Oxidized. The OS must match the LibreNMS OS name (these are all lowercase with no spaces). Only allows existing OS.',
],
'ignore_types'=>[
'description'=>'Do not backup these device types',
'help'=>'Do not backup the listed device types with Oxidized. Only allows existing types.',
'help'=>'How often to check. Sets the default value for all nodes. Warning! If you change this you must make additional changes. Check the Fast Ping docs.',
'help'=>'These cannot be changed without deleting your existing RRD files. Though one could conceivably increase or decrease the size of each RRA if one had performance problems or if one had a very fast I/O subsystem with no performance worries.',
],
'rrdcached'=>[
'description'=>'Enable rrdcached (socket)',
'help'=>'Enables rrdcached by setting the location of the rrdcached socket. Can be unix or network socket (unix:/run/rrdcached.sock or localhost:42217)',
],
'rrdtool'=>[
'description'=>'Path to rrdtool',
],
'rrdtool_tune'=>[
'description'=>'Tune all rrd port files to use max values',
'help'=>'Auto tune maximum value for rrd port files',
'description'=>'Sets the version of rrdtool on your server',
'help'=>'Anything over 1.5.5 supports all features LibreNMS uses, do not set higher than your installed version',
],
'service_poller_enabled'=>[
'description'=>'Enable Polling',
'help'=>'Enable poller workers. Sets the default value for all nodes.',
],
'service_poller_workers'=>[
'description'=>'Poller Workers',
'help'=>'Amount of poller workers to spawn. Sets the default value for all nodes.',
],
'service_poller_frequency'=>[
'description'=>'Poller Frequency (Warning!)',
'help'=>'How often to poll devices. Sets the default value for all nodes. Warning! Changing this without fixing rrd files will break graphs. See docs for more info.',
],
'service_poller_down_retry'=>[
'description'=>'Device Down Retry',
'help'=>'If a device is down when polling is attempted. This is the amount of time to wait before retrying. Sets the default value for all nodes.',
],
'service_discovery_enabled'=>[
'description'=>'Discovery Enabled',
'help'=>'Enable discovery workers. Sets the default value for all nodes.',
],
'service_discovery_workers'=>[
'description'=>'Discovery Workers',
'help'=>'Amount of discovery workers to run. Setting too high can cause overload. Sets the default value for all nodes.',
],
'service_discovery_frequency'=>[
'description'=>'Discovery Frequency',
'help'=>'How often to run device discovery. Sets the default value for all nodes. Default is 4 times a day.',
],
'service_services_enabled'=>[
'description'=>'Services Enabled',
'help'=>'Enable services workers. Sets the default value for all nodes.',
],
'service_services_workers'=>[
'description'=>'Services Workers',
'help'=>'Amount of services workers. Sets the default value for all nodes.',
],
'service_services_frequency'=>[
'description'=>'Services Frequency',
'help'=>'How often to run services. This should match poller frequency. Sets the default value for all nodes.',
],
'service_billing_enabled'=>[
'description'=>'Billing Enabled',
'help'=>'Enable billing workers. Sets the default value for all nodes.',
],
'service_billing_frequency'=>[
'description'=>'Billing Frequency',
'help'=>'How often to collect billing data. Sets the default value for all nodes.',
],
'service_billing_calculate_frequency'=>[
'description'=>'Billing Calculate Frequency',
'help'=>'How often to calculate bill usage. Sets the default value for all nodes.',
],
'service_alerting_enabled'=>[
'description'=>'Alerting Enabled',
'help'=>'Enable the alerting worker. Sets the default value for all nodes.',
],
'service_alerting_frequency'=>[
'description'=>'Alerting Frequency',
'help'=>'How often alert rules are checked. Note that data is only updated based on poller frequency. Sets the default value for all nodes.',
],
'service_ping_enabled'=>[
'description'=>'Fast Ping Enabled',
'help'=>'Fast Ping just pings devices to check if they are up or down. Sets the default value for all nodes.',
],
'service_update_enabled'=>[
'description'=>'Daily Maintenance Enabled',
'help'=>'Run daily.sh maintenance script and restart the dispatcher service afterwards. Sets the default value for all nodes.',
],
'service_update_frequency'=>[
'description'=>'Maintenance Frequency',
'help'=>'How often to run daily maintenance. Default is 1 Day. It is highly suggested not to change this. Sets the default value for all nodes.',
],
'service_loglevel'=>[
'description'=>'Log Level',
'help'=>'Log level of the dispatch service. Sets the default value for all nodes.',
],
'service_watchdog_enabled'=>[
'description'=>'Watchdog Enabled',
'help'=>'Watchdog monitors the log file and restarts the service it it has not been updated. Sets the default value for all nodes.',
],
'service_watchdog_log'=>[
'description'=>'Log File to Watch',
'help'=>'Default is the LibreNMS log file. Sets the default value for all nodes.',
'help'=>'Allow users to activate and use Timebased (TOTP) or Counterbased (HOTP) One-Time Passwords (OTP)',
],
'twofactor_lock'=>[
'description'=>'Two-Factor Throttle Time (seconds)',
'help'=>'Lock-out time to wait in seconds before allowing further attempts if Two-Factor authentication is failed 3 times consecutively - will prompt user to wait this long. Set to 0 to disable resulting in a permanent account lock-out and a message to user to contact administrator',
'description'=>'Default device display name template',
'help'=>'Sets the default display name for all devices (can be overridden per-device). Hostname/IP: Just show the hostname or IP the device was added with. sysName: Just show the sysName from snmp. Hostname or sysName: Show hostname, but if it is an IP, show sysName.',
'options'=>[
'hostname'=>'Hostname / IP',
'sysName_fallback'=>'Hostname, fallback to sysName for IPs',