nautobot
diff --git a/‎.github/workflows/ci.yml
Lines changed: 3 additions & 3 deletions b/‎.github/workflows/ci.yml
Lines changed: 3 additions & 3 deletions
diff --git a/‎development/Dockerfile
Lines changed: 2 additions & 2 deletions b/‎development/Dockerfile
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/admin/install.md
Lines changed: 1 addition & 1 deletion b/‎docs/admin/install.md
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/dev/arch_decision.md
Lines changed: 3 additions & 0 deletions b/‎docs/dev/arch_decision.md
Lines changed: 3 additions & 0 deletions
diff --git a/‎docs/dev/extending.md
Lines changed: 3 additions & 3 deletions b/‎docs/dev/extending.md
Lines changed: 3 additions & 3 deletions
diff --git a/‎docs/dev/onboarding_extensions.md
Lines changed: 2 additions & 2 deletions b/‎docs/dev/onboarding_extensions.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/user/app_detailed_design.md
Lines changed: 2 additions & 2 deletions b/‎docs/user/app_detailed_design.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/user/app_getting_started.md
Lines changed: 2 additions & 2 deletions b/‎docs/user/app_getting_started.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/user/app_overview.md
Lines changed: 5 additions & 5 deletions b/‎docs/user/app_overview.md
Lines changed: 5 additions & 5 deletions
diff --git a/‎docs/user/app_use_cases_legacy.md renamed to ‎docs/user/app_use_cases_original.md b/‎docs/user/app_use_cases_legacy.md renamed to ‎docs/user/app_use_cases_original.md
diff --git a/‎docs/user/app_yaml_overrides.md
Lines changed: 30 additions & 5 deletions b/‎docs/user/app_yaml_overrides.md
Lines changed: 30 additions & 5 deletions
diff --git a/‎docs/user/faq.md
Lines changed: 2 additions & 2 deletions b/‎docs/user/faq.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎mkdocs.yml
Lines changed: 2 additions & 1 deletion b/‎mkdocs.yml
Lines changed: 2 additions & 1 deletion
diff --git a/‎nautobot_device_onboarding/command_mappers/arista_eos.yml
Lines changed: 8 additions & 8 deletions b/‎nautobot_device_onboarding/command_mappers/arista_eos.yml
Lines changed: 8 additions & 8 deletions
diff --git a/‎nautobot_device_onboarding/command_mappers/cisco_ios.yml
Lines changed: 18 additions & 18 deletions b/‎nautobot_device_onboarding/command_mappers/cisco_ios.yml
Lines changed: 18 additions & 18 deletions
@@ -106,7 +106,7 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.11"]
-        nautobot-version: ["2.1.1"]
+        nautobot-version: ["2.2.3"]
     env:
       INVOKE_NAUTOBOT_DEVICE_ONBOARDING_PYTHON_VER: "${{ matrix.python-version }}"
       INVOKE_NAUTOBOT_DEVICE_ONBOARDING_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
@@ -149,7 +149,7 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.11"]
-        nautobot-version: ["2.1.1"]
+        nautobot-version: ["2.2.3"]
     env:
       INVOKE_NAUTOBOT_DEVICE_ONBOARDING_PYTHON_VER: "${{ matrix.python-version }}"
       INVOKE_NAUTOBOT_DEVICE_ONBOARDING_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
@@ -192,7 +192,7 @@ jobs:
         include:
           - python-version: "3.11"
             db-backend: "postgresql"
-            nautobot-version: "2.1.1"
+            nautobot-version: "2.2.3"
             # - python-version: "3.11"
             #   db-backend: "mysql"
             #   nautobot-version: "stable"
 
@@ -6,8 +6,8 @@
 # -------------------------------------------------------------------------------------
 # !!! USE CAUTION WHEN MODIFYING LINES BELOW
 
-# Accepts a desired Nautobot version as build argument, default to 2.0.3
-ARG NAUTOBOT_VER="2.0.3"
+# Accepts a desired Nautobot version as build argument, default to 2.2.3
+ARG NAUTOBOT_VER="2.2.3"
 
 # Accepts a desired Python version as build argument, default to 3.11
 ARG PYTHON_VER="3.11"
 
@@ -74,7 +74,7 @@ Then restart (if necessary) the Nautobot services which may include:
 sudo systemctl restart nautobot nautobot-worker nautobot-scheduler
 ```
 
-## App Configuration
+## App Configuration (Original)
 
 Although the app can run without providing any settings, the app behavior can be controlled with the following list of settings defined in `nautobot_config.py`:
 
 
@@ -0,0 +1,3 @@
+# Architecture Decision Records
+
+The intention is to document deviations from a standard Model View Controller (MVC) design. And other general Application decisions.
@@ -2,16 +2,16 @@
 
 Extending the application is welcome, however it is best to open an issue first, to ensure that a PR would be accepted and makes sense in terms of features and design.
 
-## Customizing Onboarding Behavior With Extensions
+## Customizing Onboarding Behavior With Extensions (Original)
 
 This plugin provides methods to customize onboarding behavior. By creating onboarding extensions, it is possible to onboard switch stacks, HA pairs and perform other customizations.
 
 Please see the dedicated FAQ for [device onboarding extensions](onboarding_extensions.md).
 
 !!! warn
-    This is the legacy onboarding extensions.  The next section covers how to extend the new framework.
+    This is the original onboarding extensions.  The next section covers how to extend the new framework.
 
-## Extending SSoT jobs (Sync Devices, and Sync Network Data)
+## Extending SSoT jobs (Sync Devices From Network, and Sync Network Data From Network)
 
 Extending the platform support for the SSoT specific jobs should be accomplished with adding a yaml file that defines commands, jdiff jmespaths, and post_processors. A PR into this library is welcomed, but this app exposes the Nautobot core datasource capabilities to be able to load in overrides from a Git repository.
 
 
@@ -1,7 +1,7 @@
-# Onboarding Extensions
+# Onboarding Extensions (Original)
 
 !!! warn
-    This is the legacy onboarding extensions.
+    This is the original onboarding extensions.
 
 ## What are onboarding extensions?
 
 
@@ -10,7 +10,7 @@ This page will describe the newer SSoT jobs that this App exposes and how they w
 - [Jdiff](https://jdiff.readthedocs.io/en/latest/usage/#extract_data_from_json) - Used to simplify parsing required data fields out of command outputs returned from command parser libraries like textFSM. Specifically `extract_data_from_json` method.
 - Parsers - Initially NTC Templates via textFSM, but future support for PyATS, TTP, etc. is expected in the future.
 
-## How the SSoT **Sync Devices** Job Works
+## How the SSoT **Sync Devices From Network** Job Works
 
 1. The job is executed with inputs selected.
     - List of comma seperated IP/DNS names is provided.
@@ -28,7 +28,7 @@ This page will describe the newer SSoT jobs that this App exposes and how they w
     - Next, the JSON result from the show command after the parser executes (E.g. textfsm), gets run through the jdiff function `extract_data_from_json()` with the data and the `jpath` from the YAML file definition.
     - Finally, an optional `post_processor` jinja2 capable execution can further transform the data for that command before passing it to finish the SSoT syncronizaton.
 
-## How the SSoT **Sync Network Data** Job Works
+## How the SSoT **Sync Network Data From Network** Job Works
 
 1. The job is executed with inputs selected.
     - One or multiple device selection.
 
@@ -8,7 +8,7 @@ To install the App, please follow the instructions detailed in the [Installation
 
 ## First steps with the App
 
-This App exposes a legacy device onboarding job, as well as two new SSoT based jobs that are considered the future of the App.
+This App exposes an original device onboarding job, as well as two new SSoT based jobs that are considered the future of the App.
 
 ### Prerequisites
 
@@ -28,7 +28,7 @@ Locations are the only other Nautobot prerequisite for the plugin to onboard a d
 
 ### Onboarding a Device
 
-Navigate to the Device Onboarding Job: Jobs > Perform Device Onboarding (Legacy).
+Navigate to the Device Onboarding Job: Jobs > Perform Device Onboarding (original).
 
 or
 
 
@@ -9,10 +9,10 @@ This [Nautobot](https://github.com/nautobot/nautobot) App allows to easily onboa
 
 ## Description/Overview
 
-### Legacy Implementation
+### Original Implementation
 
 !!! info
-    The legacy job and extensions pattern will remain a part of this App for the near future, this will allow custom extensions to continue working without causes issues to users that have taken the time and understand the legacy framework.  The newer SSoT implementation will be discussed in the next section.
+    The original job and extensions pattern will remain a part of this App for the near future, this will allow custom extensions to continue working without causes issues to users that have taken the time and understand the original framework.  The newer SSoT implementation will be discussed in the next section.
 
 The `nautobot-device-onboarding` app uses the [netmiko](https://github.com/ktbyers/netmiko) and [NAPALM](https://napalm.readthedocs.io/en/latest/) libraries to simplify the onboarding process of a new device into Nautobot down to, in many cases, an *IP Address* and a *Location*. In some cases, the user may also have to specify a specific *Device Platform* and *Device Port*.
 
@@ -52,19 +52,19 @@ The new implementation of device onboarding in this app is utilizing the SSoT fr
     - Remove the Batfish dependency.
 - Re-use backend plugins and libraries such as `nautobot-app-nornir` to provide the a similar feeling to other plugins like `nautobot-app-golden-config`.
 - Utilize SSoT framework and the new `contrib` functionality to speed up development of new features.
-- By collapsing 
+- By collapsing:
 
 Expose two new SSoT based Nautobot jobs to perform the syncing of data.
 
-1. `Sync Device SSoT Job` - Takes mininum inputs nearly identical to the legacy job (IP, Locaiton, SecretGroup), and create a device with bare minium information to be able to manage a device. This job syncs data from the network itself and creates a device with the follow attributes.
+1. `Sync Devices From Network` - Takes mininum inputs nearly identical to the original job (IP, Locaiton, SecretGroup), and create a device with bare minium information to be able to manage a device. This job syncs data from the network itself and creates a device with the follow attributes.
     - Hostname
     - Serial Number
     - Device Type
     - Platform
     - Management Interface
     - Management IP address (creates a prefix if one doesn't exist for the IP discovered.)
 
-2. `Sync Network Data SSoT Job` - From a provided list of existing Nautobot device objects, sync in additional metadata from a network device to enhance the available data from the network in Nautobot.
+2. `Sync Network Data From Network` - From a provided list of existing Nautobot device objects, sync in additional metadata from a network device to enhance the available data from the network in Nautobot.
     - All interfaces on the device with plus the attributes below:
         - Interface Name
         - MTU
 
@@ -5,7 +5,7 @@ One element of the new SSoT based jobs this app exposes; is the attempt to creat
 ## File Format
 There are only a few components to the file and they're described below:
 
-- `ssot job name` - Name of the job to define the commands and metadata needed for that job.
+- `ssot job name` - Name of the job to define the commands and metadata needed for that job. (choices: `sync_devices` or `sync_network_data`)
 - `root key data name` - Is fully defined in the schema definition.
 - `commands` - List of commands to execute in order to get the required data.
 - `command` - Actual `show` command to execute.
@@ -17,7 +17,7 @@ As an example:
 
 ```yaml
 ---
-device_onboarding:
+sync_devices:
   hostname:
     commands:
       - command: "show version"
@@ -27,18 +27,43 @@ device_onboarding:
 ..omitted..
 ```
 
+If there is only one command that needs to be run, the code base also accepts that in a dictionary format.
+
+```yaml
+---
+sync_devices:
+  hostname:
+    commands:
+      command: "show version"
+      parser: "textfsm"
+      jpath: "[*].hostname"
+      post_processor: "{{ obj[0] | upper }}"
+..omitted..
+```
+
 ## Using Datasource to Override
 
 This App provides sane defaults that have been tested, the files are located in the source code under `command_mappers`. There is potential for these sane defaults to not work in a given environment; alternatively you may want to add additional platform support in your deployment. These are the two main use cases to utilize the datasource feature this app exposes.
 
 !!! info
     To avoid overly complicating the merge logic, the App will always prefer the platform specific YAML file loaded in from the git repository.
 
+!!! warn
+    Partial YAML file merging is not supported. Meaning you can't only overload `sync_devices` definition and inherit `sync_network_data` definition.
+
 ### Properly Formatting Git Repository
 
-When loading from a Git Repository this App is expecting a root directory called `onboarding_command_mappers`. Each of the platform YAML files are then located in this directory. The YAML file names must be named `<network_driver>.yml`.
+When loading from a Git Repository this App is expecting a root directory called `onboarding_command_mappers`. Each of the platform YAML files are then located in this directory. The YAML file names must be named `<network_driver>.yml`.  Where network_driver must exist in the netutils mapping exposed from Nautobot core.
+
+To quickly get a list run:
+
+```python
+from nautobot.dcim.utils import get_all_network_driver_mappings
+
+sorted(list(get_all_network_driver_mappings().keys()))
+```
 
 ### Setting up the Git Repository
 
-1. `Extensibility -> Git Repositories`
-2. Create a new repository, most importantly selecting the `Provides` of `Onboarding Command Mappers`
+1. Extensibility -> Git Repositories
+2. Create a new repository, most importantly selecting the `Provides` of `Network Sync Job Command Mappers`
@@ -16,7 +16,7 @@ You need to disable automatic platform detection, specify the device platform ty
 
 ## Is it possible to disable the automatic creation of Device Type, Device Role or Platform?
 
-**Yes** (Legacy)! Using the plugin settings, it's possible to control individually the creation of `device_role`, `device_type`, `manufacturer` & `platform`.
+**Yes** (original)! Using the plugin settings, it's possible to control individually the creation of `device_role`, `device_type`, `manufacturer` & `platform`.
 
 ```python
 # configuration.py
@@ -49,7 +49,7 @@ Optional arguments are often used to define a `secret` for Cisco devices and oth
 
 ## Does this app support the discovery and the creation of all interfaces and IP Addresses?
 
-**Yes**. The legacy Deivce Onboarding job/SSot Sync Devices will only discover and create the management interface and the management IP address. Importing all interfaces and IP addresses is available from the SSoT job (Sync Network Data).
+**Yes**. The original Deivce Onboarding job/SSot Sync Devices will only discover and create the management interface and the management IP address. Importing all interfaces and IP addresses is available from the SSoT job (Sync Network Data).
 
 ## Does this app support the discovery of device based on fqdn?
 
 
@@ -102,7 +102,7 @@ nav:
       - App Overview: "user/app_overview.md"
       - Getting Started: "user/app_getting_started.md"
       - Using the App: "user/app_use_cases.md"
-      - Using the App (Legacy): "user/app_use_cases_legacy.md"
+      - Using the App (Original): "user/app_use_cases_original.md"
       - Frequently Asked Questions: "user/faq.md"
       - External Interactions: "user/external_interactions.md"
       - Detailed Design: "user/app_detailed_design.md"
@@ -124,6 +124,7 @@ nav:
       - Onboarding Extensions: "dev/onboarding_extensions.md"
       - Contributing to the App: "dev/contributing.md"
       - Development Environment: "dev/dev_environment.md"
+      - Architecture Decision Records: "dev/arch_decision.md"
       - Code Reference:
           - "dev/code_reference/index.md"
           - Package: "dev/code_reference/package.md"
 
@@ -1,27 +1,27 @@
 ---
-device_onboarding:
+sync_devices:
   hostname:
     commands:
-      - command: "show hostname"
-        use_textfsm: true
-        jpath: "[*].hostname"
+      command: "show hostname"
+      parser: "textfsm"
+      jpath: "[*].hostname"
   serial:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].serial_number"
   device_type:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].model"
   mgmt_interface:
     commands:
       - command: "show ip interface brief | json"
-        use_textfsm: false
+        parser: "none"
         jpath: "interfaces.*.{name: name, match_ip: interfaceAddress.ipAddr.address=='{{ obj }}'}[? match_ip].name"
   mask_length:
     commands:
       - command: "show ip interface brief | json"
-        use_textfsm: false
+        parser: "none"
         jpath: "interfaces.*.interfaceAddress[?ipAddr.address=='{{ obj }}'].ipAddr.maskLen"
@@ -1,86 +1,86 @@
 ---
-device_onboarding:
+sync_devices:
   hostname:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         post_processor: "{{ obj[0] | upper }}"
         jpath: "[*].hostname"
   serial:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].serial[0]"
   device_type:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].hardware[0]"
   mgmt_interface:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[?ip_address=='{{ obj }}'].{name: interface, enabled: link_status}"
         post_processor: "{{ (obj | selectattr('enabled', 'eq', 'up') | list | first ).name }}"
   mask_length:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[?ip_address=='{{ obj }}'].prefix_length"
         post_processor: "{{ obj | unique | first }}"
-network_importer:
+sync_network_data:
   serial:
     commands:
       - command: "show version"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].serial[0]"
   type:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, type: hardware_type}"
   ip_addresses:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, ip_address: ip_address}"
   prefix_length:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, prefix_length: prefix_length}"
   mtu:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, mtu: mtu}"
   mac_address:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, mac_address: mac_address}"
   description:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, description: description}"
   link_status:
     commands:
       - command: "show interfaces"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, link_status: link_status}"
   vrfs:
     commands:
       - command: "show vrf"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{name: name, interfaces: interfaces}"
   vlans:
     commands:
       - command: "show vlan"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interfaces: interfaces, vlan_name: vlan_name, vlan_id: vlan_id, status: status}"
   interface_vlans:
     commands:
       - command: "show interfaces switchport"
-        use_textfsm: true
+        parser: "textfsm"
         jpath: "[*].{interface: interface, admin_mode: admin_mode, access_vlan: access_vlan, native_vlan: native_vlan, trunking_vlans: trunking_vlans, voice_vlan: voice_vlan}"
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Architecture Decision Records`
	`2`	`+`
	`3`	`+The intention is to document deviations from a standard Model View Controller (MVC) design. And other general Application decisions.`