Difference between revisions of "Server Configuration Variables"

Jump to navigation Jump to search
Update requires restart for all fields, added some descriptions, more still needed...
(Update requires restart for all fields, added some descriptions, more still needed...)
Line 6: Line 6:
! Parameter !! Description !! Default !! Require Restart
! Parameter !! Description !! Default !! Require Restart
|-
|-
| ActiveDiscoveryInterval || Interval in seconds between active network discovery polls. || 7200 ||
| ActiveDiscoveryInterval || Interval in seconds between active network discovery polls. || 7200 || Yes
|-
|-
| ActiveNetworkDiscovery || Enable (1) or disable (0) active network discovery. || 0 ||
| ActiveNetworkDiscovery || Enable (1) or disable (0) active network discovery. || 0 || Yes
|-
|-
| AgentCommandTimeout || Timeout in milliseconds for commands sent to agent. If agent did not respond to command within given number of seconds, command considered as failed. || 2000 ||
| AgentCommandTimeout || Timeout in milliseconds for commands sent to agent. If agent did not respond to command within given number of seconds, command considered as failed. || 2000 || Yes
|-
|-
| AgentUpgradeWaitTime || Maximum wait time in seconds for agent restart after upgrade. If agent cannot be contacted after this time period, upgrade process is considered as failed. || 600 ||
| AgentUpgradeWaitTime || Maximum wait time in seconds for agent restart after upgrade. If agent cannot be contacted after this time period, upgrade process is considered as failed. || 600 || No
|-
|-
| AlarmHistoryRetentionTime || A number of days the server keeps an alarm history in the database || 180 ||
| AlarmHistoryRetentionTime || A number of days the server keeps an alarm history in the database || 180 || No
|-
|-
| AllowDirectSMS || Allow (1) or disallow (0) sending of SMS via NetXMS server using nxsms utility. || 0 ||
| AllowDirectSMS || Allow (1) or disallow (0) sending of SMS via NetXMS server using nxsms utility. || 0 || No
|-
|-
| AllowTrapVarbindsConversion || || 1 ||
| AllowedCiphers || A bitmask for encryption algorithms allowed in the server: 1 - AES256, 2 - Blowfish, 4 - IDEA, 8 - 3DES, 16 - AES128  (sum the values to allow multiple algorithms at once) || 31 || Yes
|-
|-
| AllowedCiphers || A bitmask for encryption algorithms allowed in the server: 1 - AES256, 2 - Blowfish, 4 - IDEA, 8 - 3DES (sum the values to allow multiple algorithms at once) || 15 ||
| AllowTrapVarbindsConversion || || 1 || Yes
|-
|-
| AuditLogRetentionTime || Retention time in days for the records in audit log. All records older than specified will be deleted by housekeeping process. || 90 ||
| AnonymousFileAccess || || 0 || No
|-
|-
| BeaconHosts || Comma-separated list of hosts to be used as beacons for checking NetXMS server network connectivity. Either DNS names or IP addresses can be used. || ||
| AuditLogRetentionTime || Retention time in days for the records in audit log. All records older than specified will be deleted by housekeeping process. || 90 || No
|-
|-
| BeaconPollingInterval || Interval in milliseconds between beacon hosts polls. || 1000 ||
| BeaconHosts || Comma-separated list of hosts to be used as beacons for checking NetXMS server network connectivity. Either DNS names or IP addresses can be used. || || Yes
|-
|-
| BeaconTimeout || Timeout in milliseconds to consider beacon host unreachable.|| 1000 ||
| BeaconPollingInterval || Interval in milliseconds between beacon hosts polls. || 1000 || Yes
|-
|-
| BlockInactiveUserAccounts || || 0 ||
| BeaconTimeout || Timeout in milliseconds to consider beacon host unreachable.|| 1000 || Yes
|-
|-
| CapabilityExpirationTime || || 604800 ||
| BlockInactiveUserAccounts || || 0 || No
|-
|-
| CheckTrustedNodes || Enable (1) or disable (0) checking of trusted nodes list for cross-node data collection (using Proxy Node DCI attribute). || 1 ||
| CapabilityExpirationTime || || 604800 || No
|-
|-
| ClientListenerPort || The server port for incoming client connections (such as management console) || 4701 ||
| CheckTrustedNodes || Enable (1) or disable (0) checking of trusted nodes list for cross-node data collection (using Proxy Node DCI attribute). || 1 || Yes
|-
|-
| ConditionPollingInterval || Interval in seconds between polling (re-evaluating) of condition objects.|| 60 ||
| ClientListenerPort || The server port for incoming client connections (such as management console) || 4701 || Yes
|-
|-
| ConfigurationPollingInterval || Interval in seconds between configuration polls.|| 3600 ||
| ConditionPollingInterval || Interval in seconds between polling (re-evaluating) of condition objects.|| 60 || Yes
|-
|-
| ConnectionPoolBaseSize || A number of connections to the database created on the server startup. || 5 ||
| ConfigurationPollingInterval || Interval in seconds between configuration polls.|| 3600 || Yes
|-
|-
| ConnectionPoolCooldownTime || || 300 ||
| ConnectionPoolBaseSize || A number of connections to the database created on the server startup. || 5 || Yes
|-
|-
| ConnectionPoolMaxSize || A maximum number of connections in the connection pool || 20 ||
| ConnectionPoolCooldownTime || || 300 || Yes
|-
|-
| DataDirectory || Directory used by server to store additional data – MIB files, agent packages, etc. || Win: \var under installation directory; UNIX: /share/netxms under installation prefix ||
| ConnectionPoolMaxSize || A maximum number of connections in the connection pool || 20 || Yes
|-
|-
| DefaultCommunityString || System-wide default SNMP community string.|| public ||
| DataDirectory || Directory used by server to store additional data – MIB files, agent packages, etc. || Win: \var under installation directory; UNIX: /share/netxms under installation prefix || ???
|-
|-
| DefaultEncryptionPolicy || Set the default encryption policy for communications with agents: 0 - encryption disabled, 1 - allowed, 2 - preferred, 3 - required || 1 ||
| DefaultCommunityString || System-wide default SNMP community string.|| public || No
|-
|-
| DeleteEmptySubnets || Enable (1) or disable (0) automatic deletion of subnet objects without any nodes within. When enabled, empty subnets will be deleted by housekeeping process.|| 1 ||
| DefaultEncryptionPolicy || Set the default encryption policy for communications with agents: 0 - encryption disabled, 1 - allowed, 2 - preferred, 3 - required || 1 || Yes
|-
|-
| DisableVacuum || Disable (1) or enable (0) VACUUM command for PostgreSQL database as part of housekeeping procedures || 0 ||
| DeleteEmptySubnets || Enable (1) or disable (0) automatic deletion of subnet objects without any nodes within. When enabled, empty subnets will be deleted by housekeeping process.|| 1 || Yes
|-
|-
| DiscoveryFilter || || ||
| DisableVacuum || Disable (1) or enable (0) VACUUM command for PostgreSQL database as part of housekeeping procedures || 0 || No
|-
|-
| DiscoveryFilterFlags || || 3 ||
| DiscoveryFilter || || || No
|-
|-
| DiscoveryPollingInterval || || 900 ||
| DiscoveryFilterFlags || || 3 || No
|-
|-
| EnableAdminInterface || || 1 ||
| DiscoveryPollingInterval || || 900 || Yes
|-
|-
| EnableAgentRegistration || || 0 ||
| EnableAdminInterface || || 1 || Yes
|-
|-
| EnableEventStormDetection || || 0 ||
| EnableAgentRegistration || Enable (1) or disable (0) agents self-registration || 1 || No
|-
|-
| EnableISCListener || || 0 ||
| EnableAuditLog || Enable (1) or disable (0) audit log || 1 || Yes
|-
|-
| EnableMultipleDBConnections || Enable (1) or disable (0) multiple database connections from the NetXMS server. This setting has no effect on SQLite databases || 1 ||
| EnableEventStormDetection || || 0 || Yes
|-
|-
| EnableNXSLContainerFunctions || Enable (1) or disable (0) server-side NXSL functions for container management (such as CreateContainer, RemoveContainer, BindObject, UnbindObject) || 0 ||
| EnableISCListener || || 0 || Yes
|-
|-
| EnableSNMPTraps || Enable (1) or disable (0) SNMP trap processing. A dedicated thread will be created if set to 1 || 1 ||
| EnableMultipleDBConnections || Enable (1) or disable (0) multiple database connections from the NetXMS server. This setting has no effect on SQLite databases || 1 || Yes
|-
|-
| EnableSyslogDaemon || || 0 ||
| EnableNXSLContainerFunctions || Enable (1) or disable (0) server-side NXSL functions for container management (such as CreateContainer, RemoveContainer, BindObject, UnbindObject) || 0 || Yes
|-
|-
| EnableZoning || || 0 ||
| EnableSNMPTraps || Enable (1) or disable (0) SNMP trap processing. A dedicated thread will be created if set to 1 || 1 || Yes
|-
|-
| EventLogRetentionTime || || 90 ||
| EnableSyslogDaemon || Enable (1) or disable (0) receiving of syslog messages. || 0 || Yes
|-
|-
| EventStormDuraction || || 15 ||
| EnableZoning || || 0 || Yes
|-
|-
| EventStormEventsPerSecond || || 100 ||
| EventLogRetentionTime || || 90 || No
|-
|-
| ExternalAuditFacility || || 13 ||
| EventStormDuraction || || 15 || Yes
|-
|-
| ExternalAuditPort || || 514 ||
| EventStormEventsPerSecond || || 100 || Yes
|-
|-
| ExternalAuditServer || || none ||
| ExternalAuditFacility || || 13 || Yes
|-
|-
| ExternalAuditSeverity || || 5 ||
| ExternalAuditPort || || 514 || Yes
|-
|-
| ExternalAuditTag || || netxmsd-audit ||
| ExternalAuditServer || || none || Yes
|-
|-
| FixedStatusValue || || 0 ||
| ExternalAuditSeverity || || 5 || Yes
|-
|-
| HouseKeepingInterval || || 3600 ||
| ExternalAuditTag || || netxmsd-audit || Yes
|-
|-
| IcmpPingSize || Size of ICMP packets (in bytes, excluding IP header size) used for status polls.|| 46 ||
| FixedStatusValue || || 0 || Yes
|-
|-
| InternalCA || Enable (1) or disable (0) internal certificate authority.|| 0 ||
| HouseKeepingInterval || || 3600 || Yes
|-
|-
| IntruderLockoutThreshold || || 0 ||
| IcmpPingSize || Size of ICMP packets (in bytes, excluding IP header size) used for status polls.|| 46 || Yes
|-
|-
| IntruderLockoutTime || || 30 ||
| InternalCA || Enable (1) or disable (0) internal certificate authority.|| 0 || Yes
|-
|-
| KeepAliveInterval || Interval in seconds between sending keep alive packets to connected clients.|| 60 ||
| IntruderLockoutThreshold || || 0 || No
|-
|-
| LockTimeout || || 60000 ||
| IntruderLockoutTime || || 30 || No
|-
|-
| LogAllSNMPTraps || || 0 ||
| JobHistoryRetentionTime || || 90 || No
|-
|-
| MailEncoding || || iso-8859-1 ||
| KeepAliveInterval || Interval in seconds between sending keep alive packets to connected clients.|| 60 || Yes
|-
|-
| MaxActiveUploadJobs || || 10 ||
| LockTimeout || || 60000 || Yes
|-
|-
| MinPasswordLength || Default minimum password length for a NetXMS user. The default applied only if per-user setting is not defined || 0 ||
| LogAllSNMPTraps || || 0 || Yes
|-
|-
| NumberOfBusinessServicePollers || A number of threads responsible for business service (SLA) monitoring || 10 ||
| MailEncoding || || iso-8859-1 || No
|-
|-
| NumberOfConditionPollers || A number of threads responsible for condition polling || 10 ||
| MaxActiveUploadJobs || || 10 || ???
|-
|-
| NumberOfConfigurationPollers || || 10 ||
| MinPasswordLength || Default minimum password length for a NetXMS user. The default applied only if per-user setting is not defined || 0 || No
|-
|-
| NumberOfDataCollectors || || 10 ||
| NumberOfBusinessServicePollers || A number of threads responsible for business service (SLA) monitoring || 10 || Yes
|-
|-
| NumberOfDatabaseWriters || || 1 ||
| NumberOfConditionPollers || A number of threads responsible for condition polling || 10 || Yes
|-
|-
| NumberOfDiscoveryPollers || || 1 ||
| NumberOfConfigurationPollers || || 10 || Yes
|-
|-
| NumberOfEventProcessors || || 1 ||
| NumberOfDatabaseWriters || || 1 || Yes
|-
|-
| NumberOfRoutingTablePollers || || 10 ||
| NumberOfDataCollectors || || 10 || Yes
|-
|-
| NumberOfStatusPollers || || 25 ||
| NumberOfDiscoveryPollers || || 1 || Yes
|-
|-
| NumberOfTopologyPollers || || 10 ||
| NumberOfEventProcessors || || 1 || Yes
|-
|-
| NumberOfUpgradeThreads || || 10 ||
| NumberOfRoutingTablePollers || || 10 || Yes
|-
|-
| PasswordComplexity || || 0 ||
| NumberOfStatusPollers || || 25 || Yes
|-
|-
| PasswordExpiration || || 0 ||
| NumberOfTopologyPollers || || 10 || Yes
|-
|-
| PasswordHistoryLength || || 0 ||
| NumberOfUpgradeThreads || || 10 || No
|-
|-
| PollCountForStatusChange || || 1 ||
| PasswordComplexity || || 0 || No
|-
|-
| RADIUSNumRetries || || 5 ||
| PasswordExpiration || || 0 || No
|-
|-
| RADIUSPort || || 1645 ||
| PasswordHistoryLength || || 0 || No
|-
|-
| RADIUSSecondaryPort || || 1645 ||
| PollCountForStatusChange || || 1 || Yes
|-
|-
| RADIUSSecondarySecret || || netxms ||
| RADIUSNumRetries || || 5 || No
|-
|-
| RADIUSSecondaryServer || || none ||
| RADIUSPort || || 1645 || No
|-
|-
| RADIUSSecret || || netxms ||
| RADIUSSecondaryPort || || 1645 || No
|-
|-
| RADIUSServer || || none ||
| RADIUSSecondarySecret || || netxms || No
|-
|-
| RADIUSTimeout || || 3 ||
| RADIUSSecondaryServer || || none || No
|-
|-
| ResolveNodeNames || || 1 ||
| RADIUSSecret || || netxms || No
|-
|-
| RoutingTableUpdateInterval || || 300 ||
| RADIUSServer || || none || No
|-
|-
| RunNetworkDiscovery || || 0 ||
| RADIUSTimeout || || 3 || No
|-
|-
| SMSDriver || || <none> ||
| ReceiveForwardedEvents || || 0 || No
|-
|-
| SMSDrvConfig || || ||
| ResolveNodeNames || || 1 || No
|-
|-
| SMTPFromAddr || || netxms@localhost||
| RoutingTableUpdateInterval || || 300 || Yes
|-
|-
| SMTPFromName || || NetXMS Server ||
| RunNetworkDiscovery || || 0 || Yes
|-
|-
| SMTPPort || || 25 ||
| SMSDriver || || <none> || Yes
|-
|-
| SMTPRetryCount || || 1 ||
| SMSDrvConfig || || || Yes
|-
|-
| SMTPServer || || localhost ||
| SMTPFromAddr || || netxms@localhost|| No
|-
|-
| SNMPRequestTimeout || || 2000 ||
| SMTPFromName || || NetXMS Server || No
|-
|-
| SlmPollingInterval || || 60 ||
| SMTPPort || || 25 || ???
|-
|-
| StatusCalculationAlgorithm || || 1 ||
| SMTPRetryCount || || 1 || No
|-
|-
| StatusPollingInterval || || 60 ||
| SMTPServer || || localhost || No
|-
|-
| StatusPropagationAlgorithm || || 1 ||
| SNMPRequestTimeout || || 2000 || Yes
|-
|-
| StatusShift || || 0 ||
| SlmPollingInterval || || 60 || ???
|-
|-
| StatusSingleThreshold || || 75 ||
| StatusCalculationAlgorithm || || 1 || Yes
|-
|-
| StatusThresholds || || ||
| StatusPollingInterval || || 60 || Yes
|-
|-
| StatusTranslation || || ||
| StatusPropagationAlgorithm || || 1 || Yes
|-
|-
| SyncInterval || || 60 ||
| StatusShift || || 0 || Yes
|-
|-
| SyncNodeNamesWithDNS || || 0 ||
| StatusSingleThreshold || || 75 || Yes
|-
|-
| SyslogListenPort || || 514 ||
| StatusThresholds || || 503C2814 || Yes
|-
|-
| SyslogParser || || <parser></parser> ||
| StatusTranslation || || 01020304 || Yes
|-
|-
| SyslogRetentionTime || || 90 ||
| SyncInterval || || 60 || Yes
|-
|-
| ThresholdRepeatInterval || || 0 ||
| SyncNodeNamesWithDNS || || 0 || No
|-
|-
| TileServerURL || || http://tile.openstreetmap.org/ ||
| SyslogListenPort || || 514 || Yes
|-
|-
| TopologyDiscoveryRadius || || 5 ||
| SyslogParser || || <parser></parser> || ???
|-
|-
| TopologyExpirationTime || || 900 ||
| SyslogRetentionTime || || 90 || No
|-
|-
| TopologyPollingInterval || || 1800 ||
| ThresholdRepeatInterval || || 0 || Yes
|-
|-
| UseDNSNameForDiscoveredNodes || || 0 ||
| TileServerURL || || http://tile.openstreetmap.org/ || No
|-
|-
| UseIfXTable || || 1 ||
| TopologyDiscoveryRadius || || 3 || No
|-
|-
| UseInterfaceAliases || || 0 ||
| TopologyExpirationTime || || 900 || No
|-
|-
| WindowsConsoleUpgradeURL || || ||
| TopologyPollingInterval || || 1800 || ???
|-
| UseDNSNameForDiscoveredNodes || || 0 || No
|-
| UseIfXTable || Enable (1) or disable (0) use of SNMP ifXTable instead of ifTable for interface configuration polling. || 1 || No
|-
| UseInterfaceAliases || || 0 || No
|-
| WindowsConsoleUpgradeURL || || http://www.netxms.org/download/netxms-%version%.exe || No
|}
|}
Items with ''???'' in requiring restart are unknown as they do not appear in Server Configuration from console by default.
20

edits

Navigation menu