基于ncclient的Netconf协议实践

ncclient==0.6.7
xmltodict==0.12.0

from ncclient import manager
#核心用到的是manager
if __name__ == '__main__':
    nexus9k_info = dict(username='XX',
                        password='XX',
                        host='XX',
                        # ip or hostname
                        hostkey_verify=False,
                        # 关闭hostkey_verify是ssh验证
                        port=10000,
                        # Netconf的协议端口，默认830，实验环境做了NAT
                        manager_params={'timeout': 180}
                         # manager的一些参数，比如timeout
                        )
    with manager.connect(**nexus9k_info) as m:
        # 用with 最后会关闭session
        server_capabilities =m.server_capabilities
        client_capabilities = m.client_capabilities


        print('server_capabilities are:')
        for i in server_capabilities:
            print(i)
        print('client_capabilities are:')
        for i in client_capabilities:
            print(i)

nexus9k_info = dict(username='XX',
                        password='XX',
                        host='XX',
                        # ip or hostname
                        hostkey_verify=False,
                        # 关闭hostkey_verify是ssh验证
                        port=10000,
                        # Netconf的协议端口，默认830，实验环境做了NAT
                        manager_params={'timeout': 180}
                         # manager的一些参数，比如timeout
                        )

# 我们的Netconf的代码，这是另一个文件了。
# 用于xml转python的dict
import xmltodict
from ncclient import manager
import pprint
from device import nexus9k_info




if __name__ == '__main__':
    # NETCONF filter to use 用于过滤get的信息
    # 比如如下，我们过滤的是interfaces的interface中名称为eth1/1的信息
    # get 获取的是配置及运行态信息
    # xmlns 是xml的命名空间，简单理解，我们用到的是openconfig的yang模型
    # 中的interfacces
    netconf_filter = '''
    <filter>
        <interfaces xmlns="http://openconfig.net/yang/interfaces">
            <interface><name>eth1/1</name></interface>
        </interfaces>
    </filter>
    '''
    with manager.connect(**nexus9k_info) as m:
        # Get Configuration and State Info for Interface
        # manager支持Netconf协议中的各类operation
        #  我们展示的是get直接调用get即可
        # 参数中传入我们的过滤用的filter xml报文
        # ncclient会帮我们去处理rpc等的封装以及底层的一些建链的交互
        # 所以这里显得非常干净利索
        netconf_reply = m.get(netconf_filter)
        intf_details = xmltodict.parse(netconf_reply.xml)
        pprint.pprint(intf_details)

import xmltodict
from ncclient import manager
import pprint
from device import nexus9k_info




if __name__ == '__main__':
    # NETCONF filter to use
    netconf_filter = '''<filter>
        <interfaces xmlns="http://openconfig.net/yang/interfaces">
            <interface><name>eth1/1</name></interface>
        </interfaces>
    </filter>'''
    with manager.connect(**nexus9k_info) as m:
        ## 这个config 也可以用add_interface_native  私有的yang 去配置3
        netconf_reply = m.get_config('running', netconf_filter)
        intf_details = dict(xmltodict.parse(netconf_reply.xml))
        print(intf_details)

import xmltodict
from ncclient import manager


from device import nexus9k_info




if __name__ == '__main__':
    add_interface_native = '''
  <config xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
    <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
      <intf-items>
        <svi-items>
           <If-list nc:operation="create">
               <id>vlan119</id>
           </If-list>
        </svi-items>
      </intf-items>
    </System>
   </config>'''
    with manager.connect(**nexus9k_info) as m:
        # Get Configuration and State Info for Interface  
        ## 这个config 也可以用add_interface_native  私有的yang 去配置
        netconf_reply = m.edit_config(config=add_interface_native ,target='running')


        # Process the XML and store in useful dictionaries
        intf_details = dict(xmltodict.parse(netconf_reply.xml))
        print(intf_details)

<config>
   <interfaces xmlns="http://openconfig.net/yang/interfaces">
        <interface>
          <name>eth1/50</name>
          <config>
            <mtu>9216</mtu>
            <description>configured with openconfig 20200505</description>
            <enabled>true</enabled>
          </config>
        </interface>
</interfaces>
</config>