blob: 7576f20176563f217c18a094d8b1374abfe5327d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# PyVyOS Documentation
PyVyOS is a Python SDK for interacting with VyOS devices via their REST API. This library provides a simple and intuitive interface to manage VyOS network devices programmatically.
## Overview
PyVyOS enables developers to:
- Configure VyOS devices remotely
- Retrieve configuration and operational data
- Manage system operations (reboot, poweroff)
- Generate SSH keys and manage images
- Save and load configuration files
## Documentation Structure
- [Installation](installation.md) - How to install PyVyOS
- [Getting Started](getting-started.md) - Quick start guide
- [API Reference](api-reference.md) - Complete API documentation
- [Configuration](configuration.md) - Device setup and authentication
- [Examples](examples.md) - Common usage patterns
- [Concepts](concepts.md) - Key concepts and architecture
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
## Requirements
- Python 3.13 or higher
- VyOS device with REST API enabled
- API key for authentication
## Quick Example
```python
from pyvyos import VyDevice
device = VyDevice(
hostname="192.168.1.1",
apikey="your-api-key",
port=443,
protocol="https",
verify=True
)
response = device.show(path=["system", "image"])
print(response.result)
```
## Resources
- [GitHub Repository](https://github.com/vyos-contrib/pyvyos)
- [PyPI Package](https://pypi.org/project/pyvyos/)
## License
MIT License - See LICENSE file for details
|
