Device Defaults and do2unix

Settings-Device-Defaults.md

@@ -1,4 +1,122 @@
 # Device Default Settings
 
+Cacti has multiple ways to create **Devices**.  Those methods include:
+
+- **Manual** - Create Devices one at a time through the User Interface
+- **CLI** - Through Cacti's Command Line Interfaces (CLI's)
+- **Automation** - Through Cacti's Network Discovery
+
+When using any of these methods, Cacti needs a way to apply a default
+for a new **Device** if the user does not specify on, be it any of the
+three methods above.  That is what this settings sub-tab if for.
+
+## General Defaults
+
+In the image below, you can see the **General Defaults**.  These settings
+cover a number of **Device** attributes.
+
+![General Defaults](images/settings-device-defaults-general.png)
+
+Those settings include:
+
+- **Template** - The default **Device Template**.  You might select `Net-SNMP` device if you
+  are monitoring all Linux devices for example.
+
+- **Site** - The default physical location of the **Device**
+
+- **Poller** - The default **Data Collector** to assign new **Devices** to
+
+- **Device Threads** - The default number of Device Threads to assign to a new **Device**
+
+- **Re-index Method for Data Queries** - The default **Re-index" method for new **Device** 
+  **Data Queries**
+
+- **Default Interface Speed** - If the **Device** does not include `ifHighSpeed` what
+  should the maximum speed of the interface be set to.
+
+> **NOTE**: **Device Threads** is only applicable when using the spine binary
+
+## SNMP Defaults
+
+Similar to the `General Defaults`, the `SNMP Defaults` control what SNMP settings to
+use for new **Devicess* if the user does not specify any.  The image below
+shows the settings when using first SNMP v2 and then SNMP v3.  If you are using 
+SNMP v1 or v2, you will have much less required settings.
+
+![SNMP Defaults](images/settings-device-defaults-snmp-defaults-v1v2.png)
+
+![SNMP Defaults](images/settings-device-defaults-snmp-defaults-v3.png)
+
+Those settings include:
+
+- **Version** - The default SNMP version to query using (v1, v2, v3)
+
+- **Community** - The default SNMP password to access the device (SNMP v1, v2)
+
+- **Port Number** - The default SNMP port number to poll (SNMP v1, v2, v3)
+
+- **Timeout** - The default SNMP Timeout (SNMP v1, v2, v3)
+
+- **Retries** - The default number of times to retry a query if SNMP times out (SNMP v1, v2, v3)
+
+- **Security Level** - The default Security Level (SNMP v3)
+
+- **Auth Protocol** - The default Authentication Portocol to use (SNMP v3)
+
+- **Auth User** - The default Authentication User to use (SNMP v3)
+
+- **Auth Password** - The default Authentication password to use (SNMP v3)
+
+- **Privacy Protocol** - The default Privacy Protocol to use (SNMP v3)
+
+- **Privacy Pass-phrase** - The default Privacy Pass-phrase to use (SNMP v3)
+
+- **SNMP Context** - The default SNMP Context to use (SNMP v3)
+
+- **SNMP Engine ID** - The default SNMP Engine ID to use (SNMP v3)
+
+## Availability / Reachability
+
+Cacti's `Availability / Reachability` define how to perform initial checks prior
+to polling to see if the **Device** is alive or not.  Attempting to gather large
+amounts of data from a **Device** that is down, is counter-productive.
+
+Availability / Reachability is generally performned using a `ping`.  These `pings`
+come in many formats, and Cacti supports all of the reasonable ones.  In the
+image below, you can see the settings for one of the combination cases.  Depending
+on your `ping` method, you may receive less options.
+
+![SNMP Defaults](images/settings-device-defaults-availability.png)
+
+Those options include:
+
+- **Downed Device Detection** - The method by which Cacti should `ping` the **Device**, SNMP `pings` involve querying a specific OID.  Options include:
+
+   - **None** - Only used for devices having their data collected through a back-end agent
+   - **Ping and SNMP uptime** - Perform a TCP/UDP/ICMP ping and then check uptime through SNMP.  Both methods must work for the device to be **Up**
+   - **Ping or SNMP Uptime** - If either method works, consider the **Device Up**
+   - **SNMP Uptime** - Only check the SNMP sysUptimeInstance of the **Device**
+   - **SNMP Desc** - Only check the SNMP sysDescription of the **Device**
+   - **SNMP getNext** - Only perform a basic `getnext` query for the **Device**
+   - **Ping** - Either TCP, UDP, or ICMP pings
+
+
+- **Ping Type** - When using an options that leverages **Ping** above, which method
+
+- **Ping Port** - When using TCP or UDP ping, the port to ping
+
+- **Ping Timeout Value** - The ping timeout value in Milliseconds
+
+- **Ping Retry Count** - The number of times to retry the ping if it fails
+
+## Up / Down Settings
+
+The Up / Down Settings define how many polling cycles that a Device must not respond to be considered truly `Down`, and when
+at device is returning from `Down`, how many polling cycles to keep a device in `Recovering` state before returning it to `Up`.
+The image below shows the two settings for the **Device**.  There is really no reason to explain these two settings in any
+additional detail.
+
+![SNMP Defaults](images/settings-device-defaults-updown.png)
+
 ---
 Copyright (c) 2004-2021 The Cacti Group

Settings-General.md

@@ -6,7 +6,7 @@ General Settings in Cacti consist of the following categories:
 - **Internationalization (i18n)** - Settings around how Cacti handles languages other than English
 - **Other Settings** - Other not object settings in Cacti
 - **Site Security** - Web Site Security settings such as `Content-Security-Policy`, use of external JavaScript API's for plugins like Google Maps, forcing https, etc.
-- **Automation** - Miscellaneous settings around Cacti's Automation
+- **Automation** - Miscellaneous settings around Cacti's Automation
 - **Graph Template Defaults** - Defaults for **Graph Templates**
 
 Each of these settings will be documented below.
@@ -66,27 +66,27 @@ Those settings include:
   System logging facility, Cacti will only forward some events as defined
   by the various check-boxes.
 
-## Internationalization (i18n)
-
-The image below shows system level Internationalization settings for Cacti, commonly
-referred to as i18n.
-
-![Internationalization Settings](images/settings-general-i18n.png)
-
-Those settings include:
-
-- **Language Support** - Whether or not to allow selecting other languages for Cacti
-
-- **Language** - The default language to use at login time, or by default when the
+## Internationalization (i18n)
+
+The image below shows system level Internationalization settings for Cacti, commonly
+referred to as i18n.
+
+![Internationalization Settings](images/settings-general-i18n.png)
+
+Those settings include:
+
+- **Language Support** - Whether or not to allow selecting other languages for Cacti
+
+- **Language** - The default language to use at login time, or by default when the
   user has not specified a language.
 
-- **Auto Language Detection** - Whether or not Cacti should read the language from the
+- **Auto Language Detection** - Whether or not Cacti should read the language from the
   browser and use that language by default.
 
-- **Date Display Format** - The default Date/Time display format.
-
-- **Date Separator** - The default Data/Time separator character.
-
+- **Date Display Format** - The default Date/Time display format.
+
+- **Date Separator** - The default Data/Time separator character.
+
 ## Other Settings
 
 These are additional settings for Cacti that fall into various categories, but that
@@ -101,44 +101,44 @@ Those settings include:
   a pages that has the various **Has** options, if checked here, the default
   will be to check that setting.
 
-- **RRDtool Version** - Selecting the correct RRDtool Version will unlock features
+- **RRDtool Version** - Selecting the correct RRDtool Version will unlock features
   expected in modern graphing frameworks that leverage SVG (Canvas) rendering.
 
-- **Graph Permission Method** - This defined if a user needs to have access to
+- **Graph Permission Method** - This defined if a user needs to have access to
   both a **Device** and **Graph Template** to view a **Devices** **Graphs**,
   otherwise known as **Restrictive** or that to view a **Devices** **Graphs**
   the user only needs either the **Device** or **Graph Template** permission.
 
-- **Graph/Data Source Creation Method** - If you wish to only create **Graphs**
+- **Graph/Data Source Creation Method** - If you wish to only create **Graphs**
   from **Graph Templates** choose the **Simple** method.  The **Advanced**
   method should only be used by people who wish to define individual **Graphs**
   with their own settings.
 
-- **Show Form/Setting Help Inline** - If this option is checked, you will be
+- **Show Form/Setting Help Inline** - If this option is checked, you will be
   able to read all form/setting help inline.  Otherwise, you will receive a
   pop-up to access form help.
 
-- **Delete Verification** - For simple object removal, things that can be removed
+- **Delete Verification** - For simple object removal, things that can be removed
   by clicking and 'X' on the page, whether or not you wish to confirm those
   deletes.
 
-- **Data Source Preservation Preset** - Whether or not you wish to preserve
+- **Data Source Preservation Preset** - Whether or not you wish to preserve
   **Data Sources** by default, or remove them when deleting **Graphs**. In
   all cases, Cacti will not allow the removal of a **Data Source** if there
   are **Graphs** using the **Data Source**.  However, some **Data Sources**
   are managed externally to Cacti, and removing those **Data Sources** by
   default may not be desired.
 
-- **Graph Auto Unlock** - If when editing a Graph you wish to always unlock
+- **Graph Auto Unlock** - If when editing a Graph you wish to always unlock
   it by default, select this option.  Not that this does have performance
   implications that may make the User Interface slower on vary large systems
   where devices have tens of thousands of **Data Sources**.
 
-- **Hide Cacti Dashboard** - This is an option used by some plugin developers
+- **Hide Cacti Dashboard** - This is an option used by some plugin developers
   who replace the default Cacti `Console` with their own contents, for example
   the Intropage plugin.
 
-- **Enable Drag-N-Drop** - Certain Cacti pages allow Drag-N-Drop.  If you
+- **Enable Drag-N-Drop** - Certain Cacti pages allow Drag-N-Drop.  If you
   with to use it, check that option.
 
 ## Site Security
@@ -149,14 +149,14 @@ The image below shows Site Security settings for Cacti.
 
 Those settings include:
 
-- **Force Connections over HTTPS** - Even if the web site allows http, redirect
+- **Force Connections over HTTPS** - Even if the web site allows http, redirect
   their browsers to HTTPS.
 
-- **Content-Security Allow Unsafe JavaScript eval() calls** - Allow plugins to use
+- **Content-Security Allow Unsafe JavaScript eval() calls** - Allow plugins to use
   the JavaScript `eval()` function call, which is historically unsafe.  However, some
   older plugins require it.
 
-- **Content-Security Alternate Sources** - If for some reason your Cacti site requires
+- **Content-Security Alternate Sources** - If for some reason your Cacti site requires
   content from a CDN or a third party site, you can include a space delimited list of URLs
   that will be able to be traversed for Cacti content.
 
@@ -168,20 +168,20 @@ The image below shows general Automation Settings for Cacti.
 
 Those settings include:
 
-- **Enable Automatic Graph Creation** - If a Cacti **Device** has Non **Data Query**
+- **Enable Automatic Graph Creation** - If a Cacti **Device** has Non **Data Query**
   **Graph Templates** associated with it, create those **Graphs** automatically when
   adding a new **Device**.  Additionally, if you have **Graph Rules** apply those
   at **Device** creation time and save time.
 
-- **Enable Automatic Tree Item Creation** - If you have Cacti **Tree Rules** apply
+- **Enable Automatic Tree Item Creation** - If you have Cacti **Tree Rules** apply
   then at **Device** creation and save time.
 
-- **Automation Notification To Email** - When Network Automation finishes, send
+- **Automation Notification To Email** - When Network Automation finishes, send
   a notification to this Email address.
 
-- **Automation Notification From Name** - The `From Name` on the Automation Email.
-
-- **Automation From Email** - The `From Email` such as noreply@cacti.net that
+- **Automation Notification From Name** - The `From Name` on the Automation Email.
+
+- **Automation From Email** - The `From Email` such as noreply@cacti.net that
   will be used for Automation notifications.
 
 ## Graph Template Defaults

Settings-Paths.md

@@ -6,19 +6,19 @@ are included in the Web Servers path, but being able to override these
 settings is important, especially for debugging issues.  Cacti's Paths
 sub-tab is broken into the following sub-sections:
 
-- **Required Tool Paths** - Paths that are essential for Cacti's operation
-
-- **Logging** - Settings associated with Cacti's logging facilities including log rotation
-
-- **Alternate Poller Path** - Locations for Cacti's spine binary and spine config file if not in the established default locations
-
-- **RRD Cleaner** - Setting for Cacti's RRDfile disposal of removed RRDfile when Data Sources are removed.
-
-When using Cacti's **Remote Data Collectors** or **Remote Pollers** the settings that
-refer for a `File Path`, or `Directory Path` will be local to the **Data Collector**.
-Therefore, you can have one set of paths for your Main Cacti site, and another set of
-paths for your Remote Poller, say in the case that they are on Windows.
-
+- **Required Tool Paths** - Paths that are essential for Cacti's operation
+
+- **Logging** - Settings associated with Cacti's logging facilities including log rotation
+
+- **Alternate Poller Path** - Locations for Cacti's spine binary and spine config file if not in the established default locations
+
+- **RRD Cleaner** - Setting for Cacti's RRDfile disposal of removed RRDfile when Data Sources are removed.
+
+When using Cacti's **Remote Data Collectors** or **Remote Pollers** the settings that
+refer for a `File Path`, or `Directory Path` will be local to the **Data Collector**.
+Therefore, you can have one set of paths for your Main Cacti site, and another set of
+paths for your Remote Poller, say in the case that they are on Windows.
+
 ## Required Tools Paths
 
 The image below shows Cacti's **Required Tool Paths** settings.
@@ -65,8 +65,8 @@ Those settings include:
 **Log Retention** - How many generations of Log files should be maintained.  Older files will
 be removed automatically.
 
-> **NOTE**: Some package maintainers control log rotation and therefore the log rotation
-> settings may be missing from certain version of Cacti if you install through a packaing
+> **NOTE**: Some package maintainers control log rotation and therefore the log rotation
+> settings may be missing from certain version of Cacti if you install through a packaing
 > tool such as `apt-get`, `yum` or `dnf`
 
 ## Alternate Poller Path
@@ -82,13 +82,13 @@ sub-section.
 
 Those settings include:
 
-- **Spine Binary File Location** - The path to the spine binary.
-
-- **Spine Config File Path** - This setting is optional.  If blank, Cacti will search
+- **Spine Binary File Location** - The path to the spine binary.
+
+- **Spine Config File Path** - This setting is optional.  If blank, Cacti will search
   the following locations for a `spine.conf` file.
 
-    - **pwd** - The same directory as spine
-    - **../etc/** - One directory up and down to the `etc` directory from the `spine` binary.
+    - **pwd** - The same directory as spine
+    - **../etc/** - One directory up and down to the `etc` directory from the `spine` binary.
     - **/etc/** - The systems /etc/ directory.
 
 ## RRD Cleaner