Metadata-Version: 2.4
Name: netdoc-collector
Version: 0.3.0
Summary: Network Documentation Platform - Collector
Project-URL: homepage, https://github.com/NetDocLab/netdoc-collector
Project-URL: documentation, https://github.com/NetDocLab/netdoc-collector/wiki
Project-URL: repository, https://github.com/NetDocLab/netdoc-collector/releases
Project-URL: issues, https://github.com/NetDocLab/netdoc-collector/issues
Author-email: Andrea Cavazzini <cavazzini.andrea@gmail.com>, Andrea Dainese <andrea.dainese@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.12
Requires-Dist: netdoc-sdk==0.2.5
Requires-Dist: netmiko==4.6.0
Requires-Dist: nornir-netmiko==1.0.1
Requires-Dist: nornir==3.5.0
Requires-Dist: psutil==7.2.2
Requires-Dist: pyyaml==6.0.3
Requires-Dist: textfsm==2.1.0
Description-Content-Type: text/markdown

# NetDoc - collector module

## Config file

```yaml
inventory: inventory.json
output: ./output
workers: 10
# backend:
#   url: http://localhost/api/v1
#   verify: false
#   timeout: 30
```

## Inventory file

```json
{
    "_meta": {
        "hostvars": {
            "eve-ng.example.com": {
                "ansible_connection": "local",
                "ansible_host": "172.24.0.1",
                "ansible_python_interpreter": "/root/eveng-cli/.venv/bin/python"
            },
            "mgmtswitch1.example.com": {
                "ansible_host": "172.25.10.2",
                "ansible_connection": "ansible.netcommon.network_cli",
                "ansible_network_os": "cisco.ios.ios",
                "ansible_user": "admin",
                "ansible_password": "Passw0rd!",
                "ansible_become": "no",
                "ansible_become_method": "enable",
                "ansible_become_password": "enable_secret",
                "netmiko_device_type": "cisco_ios",
                "netdoc_plugin": "netmiko:cisco:ios"
            }
        }
    },
    "all": {
        "hosts": [
            "eve-ng.example.com",
            "mgmtswitch1.example.com"
        ]
    },
    "site-lab": {
        "hosts": [
            "mgmtswitch1.example.com"
        ]
    }
}
```
