Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

ncclient scripts and helpers

License

NotificationsYou must be signed in to change notification settings

CiscoDevNet/ncc

New & Updated

DateStatusDescription
02/22/25Moved to Poetry
08/17/18Added option to specify # bytes displayed for UnicodeDecodeError exceptions
08/15/18Added operation timing plus helpful display of UnicodeDecodeError exceptions toncc
03/11/18Code review comments addressed, convenience links to still have .py versions of scripts added,ncc --env now shows command line option environment variables apply to
02/21/18Tweaks toncc-capture-schema plus its addition to packaged scripts
02/14/18Addition of--install-snippets and--env options toncc.
02/14/18Preparation for pip installation and PyPi upload; removing.py extensions from scripts that will be pip-installed; addition of copyright statements andLICENSE.txt; removed legacy script links.
02/09/18Addition of--ns option for XPath filters, allowing either direct list of namespace mapping or via a file (sample filehere)

Introduction

This repository presents:

  • Python scripts using the ncclient library (0.5.2 or greater as of writing) to talk to NETCONF-enabled devices.
  • Jupyter (IPython) Notebooks in the directorynotebooks.

Working Onncc

First create a virtual environment and thenpip install poetry.

PyPi Upload Instructions

First, tag your build appropriately (git tag vX.Y.Z) build usingpoetry build and ensure you have defined the repositoriesncc andncc-test in your~/.pypirc file. Then you may test the upload:

twine upload --repository ncc-test dist/ncc-X.Y.Z.tar.gz

Finally, do the production upload:

twine upload --repository ncc dist/ncc-X.Y.Z.tar.gz

Python Scripts

All scripts are insrc/scripts. Here is a description of those installed as part of the package:

  • ncc -- A kind of Swiss Army Knife script with many options to get-config, get, edit-config, pass in parameters for substitution, etc. Can be easily extended by users to have more edit-config templates or more named filter templates. Available content can be seen using the--list-templates and--list-filters parameters.

  • ncc-get-all-schema -- Script that attempts to download all the supported schema that the box has and tries to compile them, determine missing includes or imports, etc.

  • ncc-get-schema -- Script to get a single names schema and dup it toSTDOUT.

  • ncc-capture-schema -- Script to capture the schema from a device and commit int a git reposiroty structured perYangModels/yang. Uses netmiko to capture some initial device information, and needs device type passed in from CLI (per netmiko device types). Currently only supports IOS-XR, IOS-XE and NX-OS without changes. Fairly easy to add other device types.

  • ncc-yang-push -- Script to work with telemetry subscriptions.

There are som other draft scripts that can serve as examples:

  • ncc-establish-subscription.py -- Simple script to allow the creation of multiple dynamic telemetry subscriptions per an early draft of the IETF YANG Push functionality. Currently supported on IOS-XE 16.6.1 and later. Initial support was for switching platforms, with other platforms being supported in subsequent releases.Note that this script requires a fork of thencclient library. Once the Python dependencies above have been installed, the forked version may be installed using the commandpip install --upgrade git+https://github.com/CiscoDevNet/ncclient.git. Please seehere for more details.

  • ncc-filtered-get.py -- Very simple script that takes a subtree filter and does a get.

  • ncc-simple-poller.py -- Script that polls a device on a specified cadence for a specified subtree or XPath filter.

  • rc-xr.py -- Embryonic RESTCONF sample script using the Pythonrequests library.

More scripts may exist. The git repo is the most up to date record, not this README!

Running The Scripts

The scripts mostly have a fairly common set of options for help, hostname, port, username and password. Just try running with the--help option.

Note that the help text displayed here may be out of step with the actual code.Please run latest version of the script to ensure satisfaction!

ncc-establish-subscription.py

Note that this script requires a fork of thencclient library. Once the Python dependencies above have been installed, the forked version may be installed using the command:

pip install --upgrade git+https://github.com/CiscoDevNet/ncclient.git.

Please seehere for more details.

$ ./ncc-establish-subscription.py --helpusage: ncc-establish-subscription.py [-h] [--host HOST] [-u USERNAME]                                     [-p PASSWORD] [--port PORT] [-v]                                     [--delete-after DELETE_AFTER]                                     [-x XPATHS [XPATHS ...]]                                     (--period PERIOD | --dampening-period DAMPENING_PERIOD)Select your telemetry parameters:optional arguments:  -h, --help            show this help message and exit  --host HOST           The IP address for the device to connect to (default                        localhost)  -u USERNAME, --username USERNAME                        Username to use for SSH authentication (default                        'cisco')  -p PASSWORD, --password PASSWORD                        Password to use for SSH authentication (default                        'cisco')  --port PORT           Specify this if you want a non-default port (default                        830)  -v, --verbose         Exceedingly verbose logging to the console  --delete-after DELETE_AFTER                        Delete the established subscription after N seconds  -x XPATHS [XPATHS ...], --xpaths XPATHS [XPATHS ...]                        List of xpaths to subscribe to, one or more  --period PERIOD       Period in centiseconds for periodic subscription  --dampening-period DAMPENING_PERIOD                        Dampening period in centiseconds for on-change                        subscription

ncc

$ ncc --helpusage: ncc [-h] [--host HOST] [-u USERNAME] [-p PASSWORD] [--port PORT]           [--timeout TIMEOUT] [-v] [--default-op DEFAULT_OP]           [--device-type DEVICE_TYPE] [--snippets SNIPPETS]           [--ns NS [NS ...]] [--params PARAMS] [--params-file PARAMS_FILE]           [-f FILTER | --named-filter NAMED_FILTER [NAMED_FILTER ...] | -x           XPATH]           (--env | --install-snippets | -c | --is-supported IS_SUPPORTED | --list-templates | --list-filters | -g | --get-oper | --do-edits DO_EDITS [DO_EDITS ...] | -w)Select your NETCONF operation and parameters:optional arguments:  -h, --help            show this help message and exit  --host HOST           The IP address for the device to connect to (default                        localhost)  -u USERNAME, --username USERNAME                        Username to use for SSH authentication (default                        'cisco')  -p PASSWORD, --password PASSWORD                        Password to use for SSH authentication (default                        'cisco')  --port PORT           Specify this if you want a non-default port (default                        830)  --timeout TIMEOUT     NETCONF operation timeout in seconds (default 60)  -v, --verbose         Exceedingly verbose logging to the console  --default-op DEFAULT_OP                        The NETCONF default operation to use (default 'merge')  --device-type DEVICE_TYPE                        The device type to pass to ncclient (default: None)  --snippets SNIPPETS   Directory where 'snippets' can be found; default is                        location of script  --ns NS [NS ...]      Specify list of prefix=NS bindings or JSON files with                        bindings. @filename will read a JSON file and update                        the set of namespace bindings, silently overwriting                        with any redefinitions.  --params PARAMS       JSON-encoded string of parameters dictionary for                        templates  --params-file PARAMS_FILE                        JSON-encoded file of parameters dictionary for                        templates  -f FILTER, --filter FILTER                        NETCONF subtree filter  --named-filter NAMED_FILTER [NAMED_FILTER ...]                        List of named NETCONF subtree filters  -x XPATH, --xpath XPATH                        NETCONF XPath filter  --env                 Display environment variables a user can set.  --install-snippets    Use git to obtain the snippets from GitHub and copy to                        the current directory  -c, --capabilities    Display capabilities of the device.  --is-supported IS_SUPPORTED                        Query the server capabilities to determine whether the                        device claims to support YANG modules matching the                        provided regular expression. The regex provided is not                        automatically anchored to start or end. Note that the                        regex supplied must be in a format valid for Python                        and that it may be necessary to quote the argument.  --list-templates      List out named edit-config templates  --list-filters        List out named filters  -g, --get-running     Get the running config  --get-oper            Get oper data  --do-edits DO_EDITS [DO_EDITS ...]                        Execute a sequence of named templates with an optional                        default operation and a single commit when candidate                        config supported. If only writable-running support,                        ALL operations will be attempted.  -w, --where           Print where script is and exit

In subsequent sections some of its capabilities will be expanded on.

Device Capabilities

It is now possible to query the device either to return a categorized list of capabilities and models or to return the models matching a provided Python regular expression.

To get device capabilities:

python ncc --host=192.239.42.222 --capabilitiesIETF NETCONF Capabilities:urn:ietf:params:netconf:capability:rollback-on-error:1.0urn:ietf:params:netconf:base:1.1urn:ietf:params:netconf:capability:candidate:1.0urn:ietf:params:netconf:capability:validate:1.1urn:ietf:params:netconf:capability:confirmed-commit:1.1IETF Models:ietf-netconf (urn:ietf:params:xml:ns:netconf:base:1.0)ietf-syslog-types (urn:ietf:params:xml:ns:yang:ietf-syslog-types)ietf-yang-smiv2 (urn:ietf:params:xml:ns:yang:ietf-yang-smiv2)ietf-netconf-with-defaults (urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults)ietf-netconf-monitoring (urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring)ietf-yang-types (urn:ietf:params:xml:ns:yang:ietf-yang-types)iana-if-type (urn:ietf:params:xml:ns:yang:iana-if-type)ietf-inet-types (urn:ietf:params:xml:ns:yang:ietf-inet-types)OpenConfig Models:openconfig-bgp-multiprotocol (http://openconfig.net/yang/bgp-multiprotocol)openconfig-bgp-policy (http://openconfig.net/yang/bgp-policy)openconfig-bgp-types (http://openconfig.net/yang/bgp-types)openconfig-mpls-rsvp (http://openconfig.net/yang/rsvp)openconfig-routing-policy (http://openconfig.net/yang/routing-policy)openconfig-bgp-operational (http://openconfig.net/yang/bgp-operational)openconfig-extensions (http://openconfig.net/yang/openconfig-ext)openconfig-telemetry (http://openconfig.net/yang/telemetry)openconfig-mpls-sr (http://openconfig.net/yang/sr)openconfig-if-ethernet (http://openconfig.net/yang/interfaces/ethernet)openconfig-vlan (http://openconfig.net/yang/vlan)openconfig-policy-types (http://openconfig.net/yang/policy-types)openconfig-types (http://openconfig.net/yang/openconfig-types)openconfig-mpls-types (http://openconfig.net/yang/mpls-types)openconfig-if-ip (http://openconfig.net/yang/interfaces/ip)openconfig-if-aggregate (http://openconfig.net/yang/interface/aggregate)openconfig-bgp (http://openconfig.net/yang/bgp)openconfig-mpls (http://openconfig.net/yang/mpls)openconfig-interfaces (http://openconfig.net/yang/interfaces)openconfig-mpls-ldp (http://openconfig.net/yang/ldp)...etc...

To query for supported models (running against an IOS-XR image):

15:10 $ python ncc --host=192.239.42.222 --is-supported '(?i)snmp'SNMP-NOTIFICATION-MIBSNMP-MPD-MIBCisco-IOS-XR-snmp-entstatemib-cfgCisco-IOS-XR-snmp-agent-operSNMP-FRAMEWORK-MIBCisco-IOS-XR-snmp-agent-cfgSNMP-COMMUNITY-MIBCisco-IOS-XR-snmp-entitymib-operCisco-IOS-XR-snmp-test-trap-actCisco-IOS-XR-snmp-syslogmib-cfgCisco-IOS-XR-snmp-ifmib-operSNMPv2-TCSNMP-USER-BASED-SM-MIBSNMPv2-MIBCisco-IOS-XR-snmp-ifmib-cfgCisco-IOS-XR-snmp-mib-rfmib-cfgCisco-IOS-XR-snmp-ciscosensormib-cfgSNMP-VIEW-BASED-ACM-MIBCisco-IOS-XR-snmp-entitymib-cfgSNMP-TARGET-MIBCisco-IOS-XR-snmp-sensormib-operCisco-IOS-XR-snmp-frucontrolmib-cfg

Additionally, this example shows how to use case-insentitive regex matches in Python.

Snippets

Snippets are a way to pre-define edit-config messages or complex filters that you want to use from the command line. Snippets are simple Jinja2 templates, with parameters provided either from the command line or via a file.

Snippets are by default found in a directorysnippets colocated with thencc.py script.Named subtree filters are stored insnippets/filters and named edit-config templates are stored insnippets/editconfigs. The naming convention is fairly obvious; templates files end in.tmpl, but when referred to via CLI arguments the extension is ommitted.

The command line option--snippets may be used to define an alternate location for thesnippets directory.A directory structure as shown below must exist in the location pointed to by the--snippets parameter.For example,--snippets ./snippets-xe would expect the following directory structure.

snippets-xe├── editconfigs└── filters

The snippets for both edit config messages and named filters now support a JSON format for specifying parameters either on the command line of in a provided file. For example, we may have the filter snippet in fileintf-brief.tmpl:

<interfaces xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-pfi-im-cmd-oper">  <interface-briefs>    <interface-brief>      <interface-name>{{INTF_NAME}}</interface-name>    </interface-brief></interfaces>

Then, run against IOS-XR:

$ python ncc --host=192.239.42.222 --get-oper --named-filter intf-brief --params '{"INTF_NAME":"GigabitEthernet0/0/0/0"}'<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">  <interfaces xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-pfi-im-cmd-oper">   <interface-briefs>    <interface-brief>     <interface-name>GigabitEthernet0/0/0/0</interface-name>     <interface>GigabitEthernet0/0/0/0</interface>     <type>IFT_GETHERNET</type>     <state>im-state-admin-down</state>     <actual-state>im-state-admin-down</actual-state>     <line-state>im-state-admin-down</line-state>     <actual-line-state>im-state-admin-down</actual-line-state>     <encapsulation>ether</encapsulation>     <encapsulation-type-string>ARPA</encapsulation-type-string>     <mtu>1514</mtu>     <sub-interface-mtu-overhead>0</sub-interface-mtu-overhead>     <l2-transport>false</l2-transport>     <bandwidth>1000000</bandwidth>    </interface-brief>   </interface-briefs>  </interfaces> </data>

Or:

$ echo '{"INTF_NAME":"GigabitEthernet0/0/0/0"}' > test_params.json$ python ncc --host=192.239.42.222 --get-oper --named-filter intf-brief --params-file test_params.json<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">  <interfaces xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-pfi-im-cmd-oper">   <interface-briefs>    <interface-brief>     <interface-name>GigabitEthernet0/0/0/0</interface-name>     <interface>GigabitEthernet0/0/0/0</interface>     <type>IFT_GETHERNET</type>     <state>im-state-admin-down</state>     <actual-state>im-state-admin-down</actual-state>     <line-state>im-state-admin-down</line-state>     <actual-line-state>im-state-admin-down</actual-line-state>     <encapsulation>ether</encapsulation>     <encapsulation-type-string>ARPA</encapsulation-type-string>     <mtu>1514</mtu>     <sub-interface-mtu-overhead>0</sub-interface-mtu-overhead>     <l2-transport>false</l2-transport>     <bandwidth>1000000</bandwidth>    </interface-brief>   </interface-briefs>  </interfaces> </data>

If you do not supply all of the required vars, you will get an error when using the template. For example in the above

python ncc --host=192.239.42.222 --get-oper --named-filter intf-briefUndefined variable 'INTF_NAME' is undefined.  Use --params to specify json dict

If you wish to leave a variable empty (for example in a filter, rather than edit-config, you can just specify it as ""

{"INTF_NAME" : ""}

When edit-config templates or filters are listed (--list-templates or--list-filters), the variables that need to be substituted are also listed. For example:

11:28 $ ncc --list-templatesEdit-config templates:  add_neighbor                           <<-- template name    DESCRIPTION                          <<-- substitution    NEIGHBOR_ADDR    REMOTE_AS  add_static_route_default  del_neighbor    NEIGHBOR_ADDR

Running The Jupyter Notebooks

The jupyter notebook server should be run inside the same Python virtualenv as you created above for running the Python scripts, with one addition, which is to runpip install jupyter in the virtual environment, as it is not currently listed in therequirements.txt file.

Once Jupyter installed, the notebook server is run up thus:

$ pwd/opt/git-repos/ncc$ . v/bin/activate(v) EINARNN-M-D10Q:ncc einarnn$ jupyter notebook[I 16:39:38.230 NotebookApp] The port 8888 is already in use, trying another port.[I 16:39:38.240 NotebookApp] Serving notebooks from local directory: /opt/git-repos/ncc[I 16:39:38.240 NotebookApp] 0 active kernels[I 16:39:38.240 NotebookApp] The Jupyter Notebook is running at: http://localhost:8889/[I 16:39:38.240 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).

When the notebook server is running, it will also open up a web page with your default web browser, pointing to the jupyter notebook server. Just pick one of the notebooks in thenotebooks directory (*.ipynb) and away you go!!

About

ncclient scripts and helpers

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors6

[8]ページ先頭
©2009-2025 Movatter.jp