Retour d’expérience sur Cisco pyATS et Genie Parser

Vincent Bernat

Cisco pyATS est un ou­til pour l’au­to­ma­ti­sa­tion et le test du ré­seau. Il com­prend, entre autres, un en­semble d’ana­ly­seurs et de mo­dèles multi-ven­deurs open-source, Ge­nie Par­ser. Il dis­pose de 2700 ana­ly­seurs pour di­verses com­mandes sur de nom­breux sys­tèmes. Sur le pa­pier, cela semble être un ex­cellent outil !

>>> from genie.conf.base import Device
>>> device = Device("router", os="iosxr")
>>> # Hack pour analyser le résultat d'une commande sans se connecter à l'équipement
>>> device.custom.setdefault("abstraction", {})["order"] = ["os", "platform"]
>>> cmd = "show route ipv4 unicast"
>>> output = """
... Tue Oct 29 21:29:10.924 UTC
...
... O    10.13.110.0/24 [110/2] via 10.12.110.1, 5d23h, GigabitEthernet0/0/0/0.110
... """
>>> device.parse(cmd, output=output)
{'vrf': {'default': {'address_family': {'ipv4': {'routes': {'10.13.110.0/24': {'route': '10.13.110.0/24',
       'active': True,
       'route_preference': 110,
       'metric': 2,
       'source_protocol': 'ospf',
       'source_protocol_codes': 'O',
       'next_hop': {'next_hop_list': {1: {'index': 1,
          'next_hop': '10.12.110.1',
          'outgoing_interface': 'GigabitEthernet0/0/0/0.110',
          'updated': '5d23h'}}}}}}}}}}

Pre­mière dé­cep­tion : pyATS est sous li­cence pro­prié­taire et les sources ne sont pas dis­po­nibles. C’est as­sez en­nuyeux si vous ren­con­trez des pro­blèmes en de­hors de Ge­nie Par­ser. Par exemple, bien que pyATS uti­lise la com­mande ssh, il ne peut pas ex­ploi­ter mon fi­chier ssh_​config : pyATS ré­sout les noms d’hôtes avant de les four­nir à ssh. Il n’est pas prévu de pu­blier pyATS sous li­cence libre. 🤨

En­suite, Ge­nie Par­ser a deux problèmes :

  1. Les mo­dèles de don­nées uti­li­sés dé­pendent du ven­deur et du sys­tème d’ex­ploi­ta­tion, alors que la do­cu­men­ta­tion in­dique le contraire. Par exemple, le mo­dèle de don­nées uti­lisé pour les in­ter­faces IPv4 est dif­fé­rent entre NX-OS et IOS XR.
  2. Les ana­ly­seurs s’ap­puient sur des ex­pres­sions ré­gu­lières ligne par ligne pour ex­traire les don­nées et sur une lo­gique im­plé­men­tée en Py­thon. Tout cela est fra­gile et peut se bri­ser si­len­cieusement.

Pour illus­trer le deuxième point, sup­po­sons que la sor­tie de la com­mande show ipv4 vrf all interface soit :

Loopback10 is Up, ipv4 protocol is Up
  Vrf is default (vrfid 0x60000000)
  Internet protocol processing disabled
Loopback30 is Up, ipv4 protocol is Down [VRF in FWD reference]
  Vrf is ran (vrfid 0x0)
  Internet address is 203.0.113.17/32
  MTU is 1500 (1500 is available to IP)
  Helper address is not set
  Directed broadcast forwarding is disabled
  Outgoing access list is not set
  Inbound  common access list is not set, access list is not set
  Proxy ARP is disabled
  ICMP redirects are never sent
  ICMP unreachables are always sent
  ICMP mask replies are never sent
  Table Id is 0x0

Parce que l’ex­pres­sion ré­gu­lière pour ana­ly­ser un nom d’in­ter­face ne s’at­tend pas aux don­nées sup­plé­men­taires après l’état de l’in­ter­face, Ge­nie Par­ser ignore la ligne qui com­mence la dé­fi­ni­tion de Loopback30 et ana­lyse ainsi la sortie1 :

{
  "Loopback10": {
    "int_status": "up",
    "oper_status": "up",
    "vrf": "ran",
    "vrf_id": "0x0",
    "ipv4": {
      "203.0.113.17/32": {
        "ip": "203.0.113.17",
        "prefix_length": "32"
      },
      "mtu": 1500,
      "mtu_available": 1500,
      "broadcast_forwarding": "disabled",
      "proxy_arp": "disabled",
      "icmp_redirects": "never sent",
      "icmp_unreachables": "always sent",
      "icmp_replies": "never sent",
      "table_id": "0x0"
    }
  }
}

Bien que ce dé­faut soit simple à cor­ri­ger, il s’agit d’une ba­taille dif­fi­cile. Toute va­ria­tion exis­tante ou fu­ture dans la sor­tie d’une com­mande peut dé­clen­cher un bogue si­mi­laire non dé­tecté, mal­gré la bonne cou­ver­ture de tests. J’ai si­gnalé et cor­rigé plu­sieurs autres er­reurs d’ana­lyse « si­len­cieuses » : #516, #529 et #530. Une al­ter­na­tive plus ro­buste au­rait été d’uti­li­ser TextFSM et de pro­duire un aver­tis­se­ment lorsque cer­taines sor­ties ne sont pas re­con­nues, comme le fait Bat­fish, un ou­til d’ana­lyse de confi­gu­rations.

À l’ave­nir, nous pour­rons nous ap­puyer sur YANG pour l’ex­trac­tion de don­nées, mais il n’est ac­tuel­le­ment pas lar­ge­ment pris en charge par le parc ac­tuel. SNMP reste une pos­si­bi­lité va­lable, mais de nom­breuses in­for­ma­tions ne sont pas ac­ces­sibles via ce pro­to­cole. En at­ten­dant, je vous conseille de n’uti­li­ser Ge­nie Par­ser qu’avec une grande prudence.