{"id":22340559,"url":"https://github.com/kagarcia1618/network-config-tracker","last_synced_at":"2025-07-30T00:31:33.591Z","repository":{"id":152036789,"uuid":"414922144","full_name":"kagarcia1618/Network-Config-Tracker","owner":"kagarcia1618","description":"Network devices configuration change tracker.","archived":false,"fork":false,"pushed_at":"2023-08-31T09:23:23.000Z","size":709,"stargazers_count":13,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T22:11:45.184Z","etag":null,"topics":["cisco-ios","cisco-ios-xr","cisco-nxos","cryptography","gitlab","multithreading","napalm","netbox","nxapi","python"],"latest_commit_sha":null,"homepage":"https://kagarcia1618.github.io/Network-Config-Tracker/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kagarcia1618.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-08T09:20:15.000Z","updated_at":"2024-08-15T22:03:58.000Z","dependencies_parsed_at":"2023-09-14T19:17:50.856Z","dependency_job_id":null,"html_url":"https://github.com/kagarcia1618/Network-Config-Tracker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kagarcia1618/Network-Config-Tracker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kagarcia1618%2FNetwork-Config-Tracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kagarcia1618%2FNetwork-Config-Tracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kagarcia1618%2FNetwork-Config-Tracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kagarcia1618%2FNetwork-Config-Tracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kagarcia1618","download_url":"https://codeload.github.com/kagarcia1618/Network-Config-Tracker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kagarcia1618%2FNetwork-Config-Tracker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267785735,"owners_count":24144120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cisco-ios","cisco-ios-xr","cisco-nxos","cryptography","gitlab","multithreading","napalm","netbox","nxapi","python"],"created_at":"2024-12-04T07:12:11.039Z","updated_at":"2025-07-30T00:31:33.550Z","avatar_url":"https://github.com/kagarcia1618.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\nNetwork config tracker is a tool that monitors the configuration changes of your network devices using a gitlab repository. This tool requires integration to the following applications:\n\n- [Gitlab](https://about.gitlab.com/) which is used for storing the network devices configuration and to monitor the configuration changes.\n- [NetBox](https://github.com/netbox-community/netbox) which is used for maintaining the list of network devices to be monitored for configuration changes.\n\n## Documentation\n\nPlease refer to this [link](https://kagarcia1618.github.io/Network-Config-Tracker/) for the documentation.\n\n## Support Matrix\nList of supported network device platforms and NetBox parameter configuration.\n\n| Parameters          | Cisco IOS | Cisco IOS-XR | Cisco NXOS    | Juniper JunOS |\n| :----------------:  | :-------: | :----------: | :-----------: | :-----------: |\n| NetBox Platform     | Cisco IOS | Cisco IOS-XR | Cisco NXOS    | Juniper JunOS |\n| NetBox Status       | Active    | Active       | Active        | Active        | \n| NetBox Primary IPv4 | `True`    | `True`       | `True`        | `True`        |\n| Login Method        | SSH       | SSH          | SSH \\| NX-API | SSH           |\n\nTested working on:\n\n| Application | Version |\n| :---------: | :-----: |\n| Python      | 3.9     |\n| NetBox      | 3.4.7   |\n| GitLab      | 14.1.0  |\n\n## Installation\n1. Clone this repository and create a virtual environment.\n```\ngit clone https://github.com/kagarcia1618/Network-Config-Tracker.git\ncd network-config-tracker\npython3.9 -m venv venv\nsource venv/bin/activate\n```\n2. Install the requirements.\n```\npip install -r requirements.txt\n``` \n3. Create a new directory named private inside the cloned git repository directory.\n```\nmkdir private\n```\n4. Prepare the following parameter details:\n\n    * **Username** - to be used to access and get the running configuration of the network devices.\n    ```\n    admin\n    ```\n    * **Password** - to be used to access and get the running configuration of the network devices.\n    ```\n    password\n    ```\n    * **NetBox URL** - to be used identify the location of local netbox installation.\n    ```\n    https://\u003chostname | ipv4 address\u003e\n    ```\n    * **NetBox API Token** - to be used to access the NetBox URL API and get the list of network devices to be monitored.\n    ```\n    \u003capi token\u003e\n    ```\n    * **Gitlab URL** - to be used identify the location of local gitlab installation.\n    ```\n    https://\u003chostname | ipv4 address\u003e\n    ```\n    * **Gitlab Project Name** - to be used to store and monitor the network devices running configuration.\n    ```\n    kenneth/dev-config/tracker\n    ```\n    \u003e **Note:** New folder named **`configs`** will be created inside the gitlab project for storing the devices running configuration.\n    * **Gitlab Project API Token** - to be used to access the gitlab project via API.\n    ```\n    \u003capi token\u003e\n    ```\n\n5. Generate the encrypted device and application credentials by running `credentials.py` python script. The script will generate your secret key in the private folder together with the encrypted text file for device and application login access. \n```\npython credentials.py\n```\n\n6. Create a custom field named `Last Config Change` with `date` as type and assign it to `dcim | device`. This will be used by this tool to update the last recorded configuration change for a device.\n\n    **Note:** This tool will also update the device `status` in Netbox based on the result of fetching the device running configuration from the actual device.\n\n## Usage\n1.  Execute the config-tracker.py python script.\n\n    ```\n    python config-tracker.py\n    ```\n\n    **Note:** If you are using linux environment, you may configure a cronjob to regularly execute this job on your preferred time interval. Sample script below will execute the script every 10 minutes and store output logs to a text file.\n\n    ```\n    crontab -e\n    */10 * * * * cd ~/network-config-tracker/ \u0026\u0026 venv/bin/python config-tracker.py  \u003e\u003e logs/access_logs.txt\n    ```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkagarcia1618%2Fnetwork-config-tracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkagarcia1618%2Fnetwork-config-tracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkagarcia1618%2Fnetwork-config-tracker/lists"}