updated to inject desc into config (#68)

* Updated bulk config to use ncm library

Updated bulk config to use ncm library

* updated to include support for custom1/2 feilds

* updated to inject description into config

Author: jongaudu

bulk_config/README.md

@@ -1,13 +1,14 @@
 # bulk_config.py
 
-Bulk configure devices in NCM from router_grid.csv file using column headers. Also sets custom1 and custom2 fields when values are provided in the CSV.
+Bulk configure devices in NCM from router_grid.csv file using column headers. Also injects desc into config and sets custom1 and custom2 fields when values are provided in the CSV.
 
 ## Setup
 
-1. Install dependencies:
+1. Install dependencies from requirements.txt:
    ```bash
    pip install -r requirements.txt
    ```
+   This will install the required NCM library to run the script.
 
 ## Usage
 
@@ -25,7 +26,7 @@ Bulk configure devices in NCM from router_grid.csv file using column headers. Al
 
 ## Custom Fields
 
-The script automatically sets custom1 and custom2 fields for each router when these columns are present in the CSV and contain non-empty values. Simply add `custom1` and/or `custom2` columns to your router_grid.csv file.
+The script automatically injects desc into the configuration at [0][system][desc] when the desc column is present in the CSV and contains a non-empty value. It also sets custom1 and custom2 fields for each router when these columns are present in the CSV and contain non-empty values. Simply add `desc`, `custom1` and/or `custom2` columns to your router_grid.csv file.
 
 ## Example
 
@@ -34,8 +35,7 @@ For the included router_grid.csv with columns `id`, `name`, `desc`, `asset_id`,
 ```python
 "system": {
     "system_id": row_data.get('name', ''),
-    "asset_id": row_data.get('asset_id', ''),
-    "desc": row_data.get('desc', '')
+    "asset_id": row_data.get('asset_id', '')
 },
 "lan": {
     "00000000-0d93-319d-8220-4a1fb0372b51": {

bulk_config/bulk_config.py

@@ -2,15 +2,15 @@
 
 Reads router_grid.csv with column headers and applies configurations
 using the NCM library's patch_configuration_managers method.
-Also sets custom1 and custom2 fields when present in CSV.
+Also sets desc, custom1 and custom2 fields when present in CSV.
 
 To use this script:
 1. Export router_grid.csv from the Device View in NCM
 2. Use NCM's device-level Edit Config screen to build your configuration
 3. Copy the pending config output and paste it into the build_config return value
 4. Update router_grid.csv to contain the columns that need to be applied to the device level config
 5. Update build_config to reference router_grid column headers with row_data.get('column_name')
-6. If not included in router_grid.csv, add custom1 and/or custom2 columns to set those feilds
+6. If not included in router_grid.csv, add desc, custom1 and/or custom2 columns to set those fields
 7. Update csv_file variable if using a different filename than 'router_grid.csv'
 8. Update API keys below with your NCM API credentials
 """
@@ -24,10 +24,10 @@
 
 # Update these API keys with your NCM credentials
 api_keys: Dict[str, str] = {
-    "X-CP-API-ID": "5d4b40cd",
-    "X-CP-API-KEY": "4c1108d8b2da465588bb87bfe0cbbd2c",
-    "X-ECM-API-ID": "f7f08d19-61fe-49de-b634-f2629164de6b",
-    "X-ECM-API-KEY": "3f76025848c1dcd66731e4d838d0dd0a7bf27e09"
+    "X-CP-API-ID": "",
+    "X-CP-API-KEY": "",
+    "X-ECM-API-ID": "",
+    "X-ECM-API-KEY": ""
 }
 n2: ncm.NcmClientv2 = ncm.NcmClientv2(api_keys=api_keys)
 
@@ -179,14 +179,20 @@ def main() -> None:
     
     Processes each router in the CSV file by:
     1. Applying device configuration using patch_configuration_managers
-    2. Setting custom1 field if column exists and has non-empty value
-    3. Setting custom2 field if column exists and has non-empty value
+    2. Injecting desc into config[0][system][desc] if column exists and has non-empty value
+    3. Setting custom1 field if column exists and has non-empty value
+    4. Setting custom2 field if column exists and has non-empty value
     """
     rows = load_csv(csv_file)
 
     for router_id, row_data in rows.items():
         try:
             config = {'configuration': build_config(row_data)}
+            
+            desc_value: Optional[str] = row_data.get('desc')
+            if desc_value and desc_value != '':
+                config['configuration'][0]['system']['desc'] = desc_value
+            
             n2.patch_configuration_managers(
                 router_id=router_id, config_man_json=config)