diff options
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index e24228f..a82e98e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,3 +20,30 @@ Indices and tables * :ref:`modindex` * :ref:`search` +Quick introduction +================== + +A python library for executing commands on VyOS systems. + +Generic methods should also work with any of the Vyatta descendants (EdgeOS, Brocade vRouter). + +The library is compatible with both python2 and python3. + +It is released under the MIT license. + +Usage example:: + + import vymgmt + + vyos = vymgmt.Router('192.0.2.1', 'vyos', password='vyos', port=22) + + vyos.login() + vyos.configure() + + vyos.set("protocols static route 203.0.113.0/25 next-hop 192.0.2.20") + vyos.delete("system options reboot-on-panic") + + vyos.commit() + vyos.save() + vyos.exit() + vyos.logout() |