Genie Libs Ops

Common errors

• ImportError: cannot import name 'Csr1000vPatterns'

  cause This error typically occurs after an upgrade of pyATS/Genie, indicating that internal plugin structures or symbols have changed, and cached or older modules are being used.
  fix Perform a clean re-installation: `pip uninstall -y pyats genie genie.libs.ops` followed by `pip install --no-cache-dir genie` (or `pyats[full]`). Ensure you are in a clean virtual environment.

• genie.metaparser.util.exceptions.SchemaMissingKeyError: Show Command: show spanning-tree

  cause This error means the parsed output from the device did not contain an expected key or structure defined in the Genie parser's schema for that specific command. This can happen due to variations in device OS versions, unexpected output, or bugs in the parser itself.
  fix Verify the exact output of the `show` command on the device. Check the Genie Models documentation if there's an updated parser or if your device's output deviates significantly. You may need to create a custom parser or report the issue.

• Exception: Could not find parser for 'show interface status' or Search for 'show ip int br' is ambiguous.

  cause Genie's parsing mechanism could not find a matching parser for the provided command string or found multiple ambiguous matches. This is common with shorthand commands or commands not explicitly supported by a parser.
  fix Use the full, precise command string as documented in the Genie Parsers list. Avoid common CLI shorthands if they are not explicitly handled by the Genie parser.

Warnings

• breaking Python 3.6 support officially ended after April 2022. Users on older Python versions (3.6 and below) must upgrade to Python 3.7+ (preferably 3.8+) to use recent versions of Genie Libs Ops and the broader pyATS/Genie framework.
  Fix: Upgrade your Python environment to 3.7 or newer. Python 3.8+ is generally recommended for the latest Genie releases.
• gotcha While `pip install genie-libs-ops` is possible, it is highly recommended to install the full `genie` or `pyats[full]` package. `genie.libs.ops` relies heavily on other components of the `genie` and `pyats` ecosystem (e.g., connection handlers, parsers). Installing only `genie-libs-ops` can lead to missing functionalities and runtime errors if dependencies are not met.
  Fix: Use `pip install genie` or `pip install pyats[full]` to ensure all necessary components are installed.
• gotcha When using `device.parse()` or `genie learn` for network commands, shorthand or non-standard command variations might not be recognized by built-in parsers, resulting in 'Could not find parser' or 'ambiguous' errors.
  Fix: Refer to the Genie Models documentation to find the exact command string and supported features for each OS. Use the full, precise command as expected by the parser.
• deprecated Older versions of Genie (pre-19.9) had issues with multi-threaded execution, particularly when integrated with frameworks like Nornir using multiple workers. This could lead to parsing or operational state learning failures.
  Fix: Upgrade to a more recent version of Genie/pyATS (19.9 or newer) where these concurrency issues have been addressed. If upgrading is not immediately possible, use a single worker/thread for Genie operations.

Install

• pip install genie-libs-ops Install only Ops library
• pip install genie Recommended: Install Genie (includes ops)
• pip install pyats[full] Full pyATS/Genie installation (includes ops)

Imports

• Bgp

  from genie.libs.ops.bgp.iosxe.bgp import Bgp

  Example import for a specific operational state (BGP) on a specific OS (IOS-XE). Path varies by feature and OS.
• loader

  from pyats.topology import loader

  Used to load testbed YAML files, a common prerequisite for using Genie Ops objects.

Quickstart

This quickstart demonstrates how to use `genie.libs.ops` to load a testbed, instantiate an operational state object (e.g., BGP for IOS-XE), learn the device's operational state, and access the structured data. A `testbed.yaml` file is expected for device connection details. For actual execution, ensure device connectivity or mock the device behavior.

import os
from pyats.topology import loader
from genie.libs.ops.bgp.iosxe.bgp import Bgp # Example: import BGP ops for IOS-XE
import pprint

# Ensure a testbed.yaml exists or create a dummy one for demonstration
# In a real scenario, this would connect to a live device.
# For local testing, mock the connection or use a local testbed file.
# Example testbed.yaml content (place in same directory as script):
# devices:
#   Router1:
#     os: iosxe
#     type: router
#     connections:
#       cli:
#         protocol: ssh
#         ip: 10.1.1.1 # Replace with actual device IP
#         port: 22
#     credentials:
#       default:
#         username: cisco
#         password: cisco

try:
    testbed = loader.load(os.environ.get('TESTBED_FILE', 'testbed.yaml'))
    device = testbed.devices.get('Router1')
    if not device:
        raise ValueError("Device 'Router1' not found in testbed.yaml")

    # In a real scenario, device.connect() would be called here:
    # device.connect(log_stdout=False)

    # Instantiate the Ops object for BGP on the device
    bgp_ops = Bgp(device=device)

    # Learn the operational state of BGP
    # This would execute 'show' commands on the device and parse output
    # For this example, it will run against a mocked device or fail if no connection
    bgp_ops.learn()

    print(f"\nLearned BGP operational state for {device.name}:")
    pprint.pprint(bgp_ops.info)

    # Example: Check if BGP is configured in VRF default
    if 'vrf' in bgp_ops.info and 'default' in bgp_ops.info['vrf']:
        print("\nBGP is configured in VRF 'default'.")
    else:
        print("\nBGP not found in VRF 'default' or not configured.")

except Exception as e:
    print(f"An error occurred: {e}")
    print("\nEnsure 'testbed.yaml' is correctly configured and device is reachable, or mock device interaction for testing.")