Skip to main content

This repository contains pure Python implementation of the gNMI client to interact with the network functions.

Project description

pyGNMI: Python gNMI client

project version tag license

This repository contains pure Python implementation of the gNMI client to interact with the network functions.

Usage

Sample code example:

# Modules
from pygnmi.client import gNMIclient

# Variables
host = ('169.254.255.64', '57400')

# Body
if __name__ == '__main__':
    with gNMIclient(target=host, username='admin', password='admin', insecure=True) as gc:
         result = gc.get(path=['openconfig-interfaces:interfaces', 'openconfig-acl:acl'])

    print(result)

Supported requests

  • Capabilities

  • Get

  • Set

Supported operation modes

  • insecure gRPC channel (without encryption)

Tested Network Operating Systems (NOS)

  • Arista EOS

  • Nokia SR OS

Network Operating Systems (NOS) in test

  • Nokia SRLinux

License

By using the pyGNMI tool you agree with the license.

Dev Log

Release 0.2.6:

  • Added alpha version of the Subscribe operation.

Release 0.2.5:

  • Added typing hints

Release 0.2.4:

  • Minor bugfixing

Release 0.2.3:

  • Added support for IPv6 transport (now you can connect to the network function over IPv6).

Release 0.2.2:

  • Added conversion of the collected information over the gNMI into a Python dictionary for Set operation.

Release 0.2.1:

  • Fixing the bugs with improper Protobuf paths generation.

  • Now all Set operations (delete, replace, and update) are working properly.

Releast 0.2.0:

  • Added the Set operation from gNMI specification.

Releast 0.1.9:

  • Added the property datatype='all' to the get() request. The values are per the gNMI specification: all, config, state, operatonal.

Release 0.1.8:

  • Added conversion of the collected information over the gNMI into a Python dictionary for Get operation

Release 0.1.7:

  • Changing packages modules

Release 0.1.6:

  • Restructuring internal context

Release 0.1.5:

  • Minor bugfixing

Release 0.1.4:

  • Minor bugfixing

Release 0.1.3:

  • Minor bugfixing

Release 0.1.2:

  • The gNMIClient is recreated as context manger.

  • Tests with Nokia SR OS done, the module is working nice for insecure channel.

Release 0.1.1:

  • Added the Get operation out of gNMI specification.

Release 0.1.0:

  • The first release.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygnmi-0.2.6.tar.gz (18.6 kB view details)

Uploaded Source

File details

Details for the file pygnmi-0.2.6.tar.gz.

File metadata

  • Download URL: pygnmi-0.2.6.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for pygnmi-0.2.6.tar.gz
Algorithm Hash digest
SHA256 6dd98185c3e2ca46e01d38f3a654cb3dd8ad4ddf2dbe70b315af5b4f67b22811
MD5 5ce4551b4543203ddb783ccfdf519872
BLAKE2b-256 b95a559d5a9470ed816ffa3c5c42322306b7d55ab8e9c1b4dce27122d7e988ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page