bucket_FD/python-ncclient

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-ncclient
   4 VERSION=                0.6.13
   5 KEYWORDS=               python
   6 VARIANTS=               py310 py311
   7 SDESC[py310]=           Python library for NETCONF clients (3.10)
   8 SDESC[py311]=           Python library for NETCONF clients (3.11)
   9 HOMEPAGE=               https://github.com/ncclient/ncclient
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPI/n/ncclient
  14 DISTFILE[1]=            ncclient-0.6.13.tar.gz:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[py311]=           single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[py311]=           PY310=OFF PY311=ON
  23
  24 DISTNAME=               ncclient-0.6.13
  25
  26 GENERATED=              yes
  27
  28 [PY310].BUILDRUN_DEPENDS_ON=            python-setuptools:single:py310
  29                                         python-paramiko:single:py310
  30                                         python-lxml:single:py310
  31                                         python-six:single:py310
  32 [PY310].USES_ON=                        python:py310,sutools
  33
  34 [PY311].BUILDRUN_DEPENDS_ON=            python-setuptools:single:py311
  35                                         python-paramiko:single:py311
  36                                         python-lxml:single:py311
  37                                         python-six:single:py311
  38 [PY311].USES_ON=                        python:py311,sutools
  39
  40 [FILE:2313:descriptions/desc.single]
  41 ncclient: Python library for NETCONF clients
  42 --------------------------------------------
  43
  44 ncclient is a Python library that facilitates client-side scripting and
  45 application development around the NETCONF protocol. ncclient was
  46 developed by [Shikar Bhushan]. It is now
  47 maintained by `Leonidas Poulopoulos (@leopoul) <http://ncclient.org>`
  48 and `Einar Nilsen-Nygaard (@einarnn)`.
  49
  50 Docs:
  51 `http://ncclient.readthedocs.org <http://ncclient.readthedocs.org>`_
  52
  53 Github:
  54 `https://github.com/ncclient/ncclient
  55 <https://github.com/ncclient/ncclient>`_
  56
  57 Requirements:
  58 ^^^^^^^^^^^^^
  59
  60 -  Python 2.7 or Python 3.4+
  61 -  setuptools 0.6+
  62 -  Paramiko 1.7+
  63 -  lxml 3.3.0+
  64 -  libxml2
  65 -  libxslt
  66
  67 If you are on Debian/Ubuntu install the following libs (via aptitude or
  68 apt-get):
  69
  70 -  libxml2-dev
  71 -  libxslt1-dev
  72
  73 Installation:
  74 ^^^^^^^^^^^^^
  75
  76 ::
  77
  78     [ncclient] $ sudo python setup.py install
  79
  80 or via pip:
  81
  82 ::
  83
  84     pip install ncclient
  85
  86 Examples:
  87 ^^^^^^^^^
  88
  89 ::
  90
  91     [ncclient] $ python examples/juniper/*.py
  92
  93 Usage
  94 ~~~~~
  95
  96 Get device running config
  97 '''''''''''''''''''''''''
  98
  99 Use either an interactive Python console (ipython) or integrate the
 100 following in your code:
 101
 102 ::
 103
 104     from ncclient import manager
 105
 106     with manager.connect(host=host, port=830, username=user,
 107 hostkey_verify=False) as m:
 108         c = m.get_config(source='running').data_xml
 109         with open("%s.xml" % host, 'w') as f:
 110             f.write(c)
 111
 112 As of 0.4.1 ncclient integrates Juniper's and Cisco's forks, lots of new
 113 concepts
 114 have been introduced that ease management of Juniper and Cisco devices
 115 respectively.
 116 The biggest change is the introduction of device handlers in connection
 117 paramms.
 118 For example to invoke Juniper's functions annd params one has to re-write
 119 the above with
 120 **device\_params={'name':'junos'}**:
 121
 122 ::
 123
 124     from ncclient import manager
 125
 126     with manager.connect(host=host, port=830, username=user,
 127 hostkey_verify=False, device_params={'name':'junos'}) as m:
 128         c = m.get_config(source='running').data_xml
 129         with open("%s.xml" % host, 'w') as f:
 130             f.write(c)
 131
 132 Device handlers are easy to implement and prove to be futureproof.
 133
 134 Supported device handlers
 135 '''''''''''''''''''''''''
 136
 137 * Juniper: `device_params={'name':'junos'}`
 138 * Cisco:
 139     - CSR: `device_params={'name':'csr'}`
 140     - Nexus: `device_params={'name':'nexus'}`
 141
 142
 143 [FILE:101:distinfo]
 144 f9f8cea8bcbe057e1b948b9cd1b241eafb8a3f73c4981fbdfa1cc6ed69c0a7b3       105739 ncclient-0.6.13.tar.gz
 145