Genie Parser

https://github.com/suhaibqr/salrabee-genie
Admin
Genie Parser is a Python library that parses network device output into structured data, enabling...
Tokens:95,248
Snippets:509
Trust Score:2.9
License:Apache-2.0
Update:10 months ago
Show doc for...
Tokens:
Raw
### AireOS Boot Information Parser Example (Python)

Source: https://context7.com/suhaibqr/salrabee-genie/llms.txt

Example of using the AireOS 'ShowBoot' parser to extract boot image configuration information. It demonstrates parsing the output and accessing specific details like version number and status.

```python
from genie.libs.parser.aireos.show_boot import ShowBoot

output = """
Primary Boot Image............................... 8.10.151.0 (default)
Backup Boot Image................................ 8.2.170.0 (active)
"""

class MockDevice:
    def execute(self, cmd):
        return output

parser = ShowBoot(device=MockDevice())
result = parser.cli(output=output)

print(result['primary_boot_image']['version_num'])  # '8.10.151.0'
print(result['primary_boot_image']['default'])      # 'default'
print(result['backup_boot_image']['version_num'])   # '8.2.170.0'
print(result['backup_boot_image']['status'])        # 'active'
```

--------------------------------

### Write Changelog Entry Example

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/README.md

Example of how to format a changelog entry for contributions to the Genie Parser. It follows a specific structure for detailing modifications to parsers, including schema changes and regex pattern updates.

```rst
--------------------------------------------------------------------------------
                            Fix
--------------------------------------------------------------------------------
* NXOS
    * Modified ShowVersion:
        * Changed <key1>, <key2> from schema to Optional.
        * Updated regex pattern <p1> to accommodate various outputs.
```

--------------------------------

### Install Genie Parser

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/README.md

Installs the Genie package, which is automatically included when pyATS is installed. This command ensures all necessary components for pyATS and Genie are set up.

```bash
pip install 'pyats[full]'
```

--------------------------------

### Install Genie Parser with pip

Source: https://context7.com/suhaibqr/salrabee-genie/llms.txt

Instructions for installing the Genie Parser library using pip. This includes installing the full pyATS suite, upgrading only the parser package, and installing pre-release versions.

```bash
# Install full pyATS suite (includes Genie Parser)
pip install 'pyats[full]'

# Install or upgrade only the parser package
pip install --upgrade genie.libs.parser

# Install pre-release versions
pip install --pre genie.libs.parser
```

--------------------------------

### Develop Genie Parser Package

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/README.md

Steps to set up the development environment for the Genie Parser package. This includes cloning the repository, sourcing the pyATS environment, and installing the package in development mode.

```bash
git clone https://github.com/CiscoTestAutomation/genieparser.git
source /path/to/pyats_workspace/env.sh (or env.csh)
cd genieparser
make develop
```

--------------------------------

### Create Custom Genie Parser with Python

Source: https://context7.com/suhaibqr/salrabee-genie/llms.txt

Example of creating a custom parser for the 'show version' command using Genie's MetaParser base class. It defines the schema and implements the parsing logic using regular expressions.

```python
import re
from genie.metaparser import MetaParser
from genie.metaparser.util.schemaengine import Any, Optional, Schema

class ShowVersionSchema(MetaParser):
    """Schema for show version command"""
    schema = {
        'version': str,
        'hostname': str,
        'uptime': str,
        Optional('serial_number'): str,
        Optional('image'): str
    }

class ShowVersion(ShowVersionSchema):
    """Parser for show version command"""

    cli_command = 'show version'

    def cli(self, output=None):
        if output is None:
            output = self.device.execute(self.cli_command)

        result = {}

        # Cisco IOS Software, Version 15.2(4)M
        p1 = re.compile(r'^Cisco IOS Software.*Version\s+(?P<version>\S+)')

        # Router hostname: RT-01
        p2 = re.compile(r'^(?P<hostname>\S+)\s+uptime\s+is\s+(?P<uptime>.+)')

        # Processor board ID FOC1234ABCD
        p3 = re.compile(r'Processor board ID\s+(?P<serial>\S+)')

        for line in output.splitlines():
            line = line.strip()

            m = p1.match(line)
            if m:
                result['version'] = m.group('version')
                continue

            m = p2.match(line)
            if m:
                result['hostname'] = m.group('hostname')
                result['uptime'] = m.group('uptime')
                continue

            m = p3.match(line)
            if m:
                result['serial_number'] = m.group('serial')
                continue

        return result
```

--------------------------------

### Parse Network Interface Monitor Output with salrabee-genie (Python)

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxr/rv1/tests/MonitorInterface/cli/equal/golden_output6_output.txt

This snippet demonstrates how to use the `dev.parse()` function from the salrabee-genie library to parse the output of a network interface monitoring command. It takes the command string as input and returns a structured representation of the interface status, traffic, and error statistics. No external dependencies beyond the salrabee-genie library are required.

```python
from genie.testbed import load

testbed = load('testbed.yaml')

dev = testbed.devices['R2_xr']
dev.connect()

output = dev.parse('monitor interface MgmtEth0/RP0/CPU0/0')

print(output)

```

--------------------------------

### Install Genie Parser Component using pip

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/DESCRIPTION.rst

Commands to install the Genie parser component. This includes installing the entire Genie package or upgrading/installing specific pre-release versions. Pip is the standard package installer for Python.

```console
# install genie as a whole
$ pip install genie
```

```console
# to upgrade this package manually
$ pip install --upgrade genie.libs.parser
```

```console
# to install alpha/beta versions, add --pre
$ pip install --pre genie.libs.parser
```

--------------------------------

### Bash Commands for Genie Development Workflow

Source: https://context7.com/suhaibqr/salrabee-genie/llms.txt

Provides a sequence of bash commands to set up the development environment for the Genie project. This includes cloning the repository, creating and activating a virtual environment, installing the project in development mode, generating JSON metadata, running unit tests, linting code, and building the package. These commands are essential for contributing to or customizing the Genie library.

```bash
# Clone repository
git clone https://github.com/CiscoTestAutomation/genieparser.git
cd genieparser

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install in development mode
make develop

# Generate JSON metadata for Genie features
make json

# Run unit tests
make test

# Run tests for specific folder
cd tests
pyats run job folder_parsing_job.py --no-mail

# Run linting
make pylint_all

# Build package
make package
```

--------------------------------

### Show LISP All Instance Summary Command Output

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxe/tests/ShowLispServiceServerSummary/cli/equal/golden_output3_output.txt

This output displays the LISP configuration summary for various instance IDs on a router. It indicates the status of site registrations and MAC address summarization for each instance. Dependencies include the router's LISP configuration. The primary input is the 'show lisp all instance-id * ethernet server summary' command. Limitations include that this is purely informational and does not detail configuration commands.

```text
OTT-LISP-C9K-20-MSMR#show lisp all instance-id * ethernet server summary
=================================================
Output for router lisp 2 instance-id 101
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
xtr1_1                        0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 102
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
xtr1_2                        0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 103
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
provider                      0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 104
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
xtr1_3                        0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 107
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
prov1                         0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 108
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
prov2                         0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

=================================================
Output for router lisp 2 instance-id 109
=================================================
*********************************
** NO LOCATOR-TABLE CONFIGURED **
*********************************

                     -----------  MAC  -----------
 Site name            Configured Registered Incons
prov3                         0          0      0

Site-registration limit for router lisp 2:            0
Site-registration count for router lisp 2:            0
Number of configured sites:                           1
Number of registered sites:                           0
Sites with inconsistent registrations:                0

        
```

--------------------------------

### Show Run Interface

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show running-config interface' command, adding regex for specific policies.

```APIDOC
## GET show running-config interface

### Description
Parses the 'show running-config interface' command to display interface configurations. Includes added regex for `ipv6_nd_raguard_attach_policy` and `device_tracking_attach_policy`.

### Method
GET

### Endpoint
/api/v1/cli/show running-config interface

### Request Example
```json
{
  "cli_command": "show running-config interface"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed interface running configuration ..."
}
```
```

--------------------------------

### NX-OS Show Commands

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/august.rst

Parsers for 'show' commands specific to NX-OS devices.

```APIDOC
## ShowFex

### Description
Parses the output of the 'show fex' command on NX-OS devices.

### Method
GET

### Endpoint
/nxos/show/fex

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **fex_details** (object) - Detailed information about FEX modules.

#### Response Example
```json
{
  "fex_details": {
    "101": {
      "state": "Online",
      "model": "N2K-C2232TM-E",
      "serial": "FOC12345678"
    }
  }
}
```
```

--------------------------------

### Configure Network Interface and IP Addressing

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxe/tests/ShowRunInterface/cli/equal/golden_output27_output.txt

Configures a network interface with IPv4 and IPv6 addresses, enabling OSPF routing. This snippet demonstrates basic interface setup for Layer 3 connectivity.

```cisco_ios
interface TwoGigabitEthernet1/0/36
 no switchport
 ip address 50.0.0.2 255.255.255.0
 ip ospf 1 area 0
 ipv6 address 50::2/64
 ipv6 enable
 ospfv3 1 ipv6 area 0
```

--------------------------------

### Parse Pre-Collected Output with Genie (Python)

Source: https://context7.com/suhaibqr/salrabee-genie/llms.txt

Shows how to parse command output that has already been collected, without needing a live device connection. It uses a mock device object to simulate command execution.

```python
from genie.libs.parser.aireos.ping import Ping

# Raw output from ping command
output = """
Ping 17.25.15.1
Send count=10, Receive count=10 from 17.25.15.1, Packet size = 2000
"""

# Instantiate parser with mock device
class MockDevice:
    def execute(self, cmd):
        return output

parser = Ping(device=MockDevice())
result = parser.cli(addr='17.25.15.1', count=10, size=2000, output=output)

# Access parsed data
print(result)
# {
#     'ping': {
#         'address': '17.25.15.1',
#         'repeat': 10,
#         'statistics': {
#             'send': 10,
#             'received': 10,
#             'packet_size': 2000
#         }
#     }
# }
```

--------------------------------

### Crypto PKI Certificate Pool Configuration

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxe/tests/AcmConfigletStatus/cli/equal/golden_output_output.txt

A configuration snippet related to Certificate Pools within a Public Key Infrastructure (PKI) setup. This is typically used for managing digital certificates.

```network-config
crypto pki certificate pool
```

--------------------------------

### Show MDNS-SD Controller Detail

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show mdns-sd controller detail' command.

```APIDOC
## GET show mdns-sd controller detail

### Description
Parses the 'show mdns-sd controller detail' command to display detailed information about the MDNS-SD controller.

### Method
GET

### Endpoint
/api/v1/cli/show mdns-sd controller detail

### Request Example
```json
{
  "cli_command": "show mdns-sd controller detail"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed MDNS-SD controller details ..."
}
```
```

--------------------------------

### Route Policy: Add Backup Path

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxr/tests/ShowRplRoutePolicy/cli/equal/golden5_output.txt

Defines a route policy 'ADD-BACKUP-PATH-RPL' to set the path selection to backup 1, install it, and enable multipath protection. This policy is used to ensure redundancy in path selection.

```network-configuration
route-policy ADD-BACKUP-PATH-RPL
  set path-selection backup 1 install multipath-protect
end-policy
```

--------------------------------

### List Data Prefix List for VPNs

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxe/tests/ShowSdwanPolicyFromVsmart/cli/equal/golden_output_output.txt

This snippet demonstrates how to list data prefix lists for specific VPNs. It includes an example for 'site1_vpn10_ipv4' with an IP prefix of '10.10.1.0/24'. This is useful for defining network segmentation and routing policies.

```text
from-vsmart lists data-prefix-list site1_vpn10_ipv4
 ip-prefix 10.10.1.0/24
```

```text
from-vsmart lists data-prefix-list site6_service_ipv4_red
 ip-prefix 10.10.6.32/27
```

```text
from-vsmart lists data-prefix-list site8_vpn11_ipv4
 ip-prefix 10.11.8.0/24
```

--------------------------------

### Show Platform Software BP Crimson Content Config

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software bp crimson content config' command.

```APIDOC
## GET show platform software bp crimson content config

### Description
Parses the 'show platform software bp crimson content config' command to display the configuration of the BP Crimson content.

### Method
GET

### Endpoint
/api/v1/cli/show platform software bp crimson content config

### Request Example
```json
{
  "cli_command": "show platform software bp crimson content config"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed Crimson content configuration ..."
}
```
```

--------------------------------

### Show Event Manager Environment

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses 'show event manager environment' commands for IOS-XR.

```APIDOC
## GET Show Event Manager Environment Commands (IOS-XR)

### Description
Parses commands to display Event Manager environment variables on IOS-XR. Supports showing all variables or filtering by a specific event name.

### Method
GET

### Endpoint Examples
- `/api/v1/cli/show event manager environment`
- `/api/v1/cli/show event manager environment all`
- `/api/v1/cli/show event manager environment | include {event_name}`

### Parameters
#### Path Parameters
- **event_name** (string) - Optional - The name of the event to filter by.

### Request Example
```json
{
  "cli_command": "show event manager environment | include my_event"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed Event Manager environment information ..."
}
```
```

--------------------------------

### Route Policy: Set Path Selection Backup

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxr/tests/ShowRplRoutePolicy/cli/equal/golden5_output.txt

Configures route policies 'ADD-PATH' and 'RP-BACKUP-PATH' to set the path selection to prefer backup paths with specific installation and multipath protection options. Used for redundancy and load balancing.

```network-configuration
route-policy ADD-PATH
  set path-selection backup 1 install multipath-protect
end-policy
```

```network-configuration
route-policy RP-BACKUP-PATH
  set path-selection backup 1 install
end-policy
```

--------------------------------

### Show Device Tracking Database Interface

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show device-tracking database interface' command, with improved regex for network and link layer addresses.

```APIDOC
## GET show device-tracking database interface

### Description
Parses the 'show device-tracking database interface' command to display device tracking information per interface. Includes enhanced parsing for network and link layer addresses.

### Method
GET

### Endpoint
/api/v1/cli/show device-tracking database interface

### Request Example
```json
{
  "cli_command": "show device-tracking database interface"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed device tracking database information ..."
}
```
```

--------------------------------

### Show Spanning Tree PVST Configuration Example

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/iosxr/tests/ShowSpanningTreePvrst/cli/equal/golden_output_1_output.txt

This snippet displays the raw output of the 'show spanning-tree pvrst a' command. It includes details about the Root ID, Bridge ID, and the role and state of each interface for multiple VLANs.

```text
RP/0/RSP0/CPU0:vkg3#show spanning-tree pvrst a       
Role:  ROOT=Root, DSGN=Designated, ALT=Alternate, BKP=Backup
State: FWD=Forwarding, LRN=Learning, BLK=Blocked


VLAN 2:

  Root ID    Priority    32768
	     Address     0021.1bff.d973
	     Max Age 20 sec, Forward Delay 15 sec


  Bridge ID  Priority    32768 (priority 32768 sys-id-ext 0)
	     Address     8cb6.4fff.6588
	     Max Age 20 sec, Forward Delay 15 sec
	     Transmit Hold count   6


Interface    Port ID           Role State Designated           Port ID
	     Pri.Nbr Cost                 Bridge ID            Pri.Nbr 
------------ ------- --------- ---- ----- -------------------- -------
Gi0/7/0/0    128.1   20000     DSGN FWD   32768 8cb6.4fff.6588 128.1
Gi0/7/0/1    128.2   20000     DSGN FWD   32768 8cb6.4fff.6588 128.2  
Gi0/7/0/10   128.3   20000     ROOT FWD   32768 0021.1bff.d973 128.3  
Gi0/7/0/11   128.4   20000     ALT  BLK   32768 0021.1bff.d973 128.4  

VLAN 3:

  Root ID    Priority    32768
	     Address     0021.1bff.d973
	     Max Age 20 sec, Forward Delay 15 sec


  Bridge ID  Priority    32768 (priority 32768 sys-id-ext 0)
	     Address     8cb6.4fff.6588
	     Max Age 20 sec, Forward Delay 15 sec
	     Transmit Hold count  6


Interface    Port ID           Role State Designated           Port ID
	     Pri.Nbr Cost                 Bridge ID            Pri.Nbr 
------------ ------- --------- ---- ----- -------------------- -------
Gi0/7/0/0    128.1   20000     DSGN FWD   32768 8cb6.4fff.6588 128.1  
Gi0/7/0/1    128.2   20000     DSGN FWD   32768 8cb6.4fff.6588 128.2  
Gi0/7/0/10   128.3   20000     ROOT FWD   32768 0021.1bff.d973 128.3  
Gi0/7/0/11   128.4   20000     ALT  BLK   32768 0021.1bff.d973 128.4  

VLAN 4:

  Root ID    Priority    32768
	     Address     0021.1bff.d973
	     Max Age 20 sec, Forward Delay 15 sec


  Bridge ID  Priority    32768 (priority 32768 sys-id-ext 0)
	     Address     8cb6.4fff.6588
	     Max Age 20 sec, Forward Delay 15 sec
	     Transmit Hold count  6


Interface    Port ID           Role State Designated           Port ID
	     Pri.Nbr Cost                 Bridge ID            Pri.Nbr 
------------ ------- --------- ---- ----- -------------------- -------
Gi0/7/0/0    128.1   20000     DSGN FWD   32768 8cb6.4fff.6588 128.1  
Gi0/7/0/1    128.2   20000     DSGN FWD   32768 8cb6.4fff.6588 128.2  
Gi0/7/0/10   128.3   20000     ROOT FWD   32768 0021.1bff.d973 128.3  
Gi0/7/0/11   128.4   20000     ALT  BLK   32768 0021.1bff.d973 128.4

```

--------------------------------

### Configure VNI Member with Multisite Multicast Group

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/nxos/tests/ShowRunningConfigNvOverlay/cli/equal/golden_output_output.txt

Configures VNI members to use a specific multisite multicast group along with a general multicast group. This is typically used for multicast traffic distribution in an EVPN multisite setup.

```network-config
member vni 10103
  multisite mcast-group 226.1.1.1
  mcast-group 231.100.1.1
```

--------------------------------

### Show Platform Software Node Cluster Manager Switch Mode B0 Local

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software node cluster-manager switch {mode} B0 local' command.

```APIDOC
## GET show platform software node cluster-manager switch {mode} B0 local

### Description
Parses the 'show platform software node cluster-manager switch {mode} B0 local' command to display local information for the cluster manager.

### Method
GET

### Endpoint
/api/v1/cli/show platform software node cluster-manager switch {mode} B0 local

### Parameters
#### Path Parameters
- **mode** (string) - Required - The switch mode (e.g., 'active', 'standby').

### Request Example
```json
{
  "cli_command": "show platform software node cluster-manager switch active B0 local"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed local cluster manager information ..."
}
```
```

--------------------------------

### Configure VNI Range with Associate VRF and Optimized Ingress Replication

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/nxos/tests/ShowRunningConfigNvOverlay/cli/equal/golden_output_output.txt

Configures a range of VNI members to associate with a VRF and utilize optimized multisite ingress replication. This setup enhances traffic management and replication efficiency across sites.

```network-config
member vni 100000-100002 associate-vrf
member vni 100004 associate-vrf
  multisite ingress-replication optimized
  mcast-group 231.200.1.1
member vni 100006 associate-vrf
  multisite ingress-replication optimized
  mcast-group 231.200.1.1
```

--------------------------------

### Show Platform Software CPM Switch Mode B0 Resource

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software cpm switch {mode} B0 resource' command.

```APIDOC
## GET show platform software cpm switch {mode} B0 resource

### Description
Parses the 'show platform software cpm switch {mode} B0 resource' command to display resource utilization for the CPM switch.

### Method
GET

### Endpoint
/api/v1/cli/show platform software cpm switch {mode} B0 resource

### Parameters
#### Path Parameters
- **mode** (string) - Required - The mode of the CPM switch (e.g., 'active', 'standby').

### Request Example
```json
{
  "cli_command": "show platform software cpm switch active B0 resource"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed resource information ..."
}
```
```

--------------------------------

### Interpreting CDP Neighbors Output

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/src/genie/libs/parser/ios/tests/ShowCdpNeighbors/cli/equal/device_output_1_output.txt

This example demonstrates the output of the 'show cdp neighbors' command on a Cisco device. It shows connected devices, their local interfaces, hold times, capabilities, platforms, and port IDs. Understanding this output is crucial for network discovery and troubleshooting.

```text
Device# show cdp neighbors

Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
                S - Switch, H - Host, I - IGMP, r - Repeater

Device ID        Local Interfce     Holdtme    Capability  Platform  ''
Port ID

R5.cisco.com     Gig 0/0           125              R B              Gig 0/0
RX-SWV.cisco.com Fas 0/1            167         T S       WS-C3524-XFas 0/13
C2950-1          Fas 0/0            148         S I       WS-C2950T-Fas 0/15
SEP08000F8BA7FD  Gig 1/0/7         179              H P   Mitel 532 Port 1

Total cdp entries displayed : 4
```

--------------------------------

### POWER Commands

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2019/APRIL.md

Retrieve information about power stacking and inline power on interfaces.

```APIDOC
## GET /network/ios/power/stack

### Description
Displays information about the power stack configuration.

### Method
GET

### Endpoint
/network/ios/power/stack

### Parameters

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **stack_power_info** (string) - Details about the power stack.

#### Response Example
```json
{
  "stack_power_info": "Stack power status: enabled, load balancing: round-robin"
}
```

## GET /network/ios/power/inline/interface/{interface}

### Description
Displays inline power status for a specific interface.

### Method
GET

### Endpoint
/network/ios/power/inline/interface/{interface}

### Parameters
#### Path Parameters
- **interface** (string) - Required - The interface name (e.g., Gi1/0/1).

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **inline_power_status** (string) - The inline power status for the interface.

#### Response Example
```json
{
  "inline_power_status": "Interface Gi1/0/1: inline power enabled, maximum 15.4W"
}
```
```

--------------------------------

### Show Crypto IKEv2 SA Local Detail

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/february.rst

Parses the 'show crypto ikev2 sa local {ip_address} detail' command to retrieve detailed information about local IKEv2 security associations.

```APIDOC
## SHOW CRYPTO IKEV2 SA LOCAL DETAIL

### Description
Parses the 'show crypto ikev2 sa local {ip_address} detail' command.

### Method
GET

### Endpoint
/api/show/crypto/ikev2/sa/local/{ip_address}/detail

### Parameters
#### Path Parameters
- **ip_address** (string) - Required - The local IP address for the IKEv2 SA.

#### Query Parameters
- **output** (string) - Optional - Specify output format (e.g., 'json').

### Request Example
```json
{
  "example": "/api/show/crypto/ikev2/sa/local/192.168.0.1/detail?output=json"
}
```

### Response
#### Success Response (200)
- **sa_details** (array) - List of detailed local IKEv2 SA information.
  - **sa_id** (string) - SA identifier.
  - **remote_ip** (string) - Remote IP address.
  - **local_ip** (string) - Local IP address.
  - **status** (string) - Status of the SA.
  - **encryption** (string) - Encryption algorithm.
  - **integrity** (string) - Integrity algorithm.

#### Response Example
```json
{
  "example": {
    "sa_details": [
      {
        "sa_id": "1",
        "remote_ip": "10.1.1.1",
        "local_ip": "192.168.0.1",
        "status": "ESTABLISHED",
        "encryption": "AES-256",
        "integrity": "SHA256"
      }
    ]
  }
}
```
```

--------------------------------

### Show ISIS RIB Flex Algo

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show isis rib flex-algo' command.

```APIDOC
## GET show isis rib flex-algo

### Description
Parses the 'show isis rib flex-algo' command to display the ISIS RIB information for flex-algo.

### Method
GET

### Endpoint
/api/v1/cli/show isis rib flex-algo

### Request Example
```json
{
  "cli_command": "show isis rib flex-algo"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed ISIS RIB flex-algo information ..."
}
```
```

--------------------------------

### Show Stackwise Virtual Bandwidth

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show stackwise-virtual bandwidth' command.

```APIDOC
## GET show stackwise-virtual bandwidth

### Description
Parses the 'show stackwise-virtual bandwidth' command to display the bandwidth information for Stackwise Virtual.

### Method
GET

### Endpoint
/api/v1/cli/show stackwise-virtual bandwidth

### Request Example
```json
{
  "cli_command": "show stackwise-virtual bandwidth"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed Stackwise Virtual bandwidth information ..."
}
```
```

--------------------------------

### Show Platform Software CPM Switch Mode B0 Control Info

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software cpm switch {mode} B0 control-info' command.

```APIDOC
## GET show platform software cpm switch {mode} B0 control-info

### Description
Parses the 'show platform software cpm switch {mode} B0 control-info' command to retrieve control information for the CPM switch.

### Method
GET

### Endpoint
/api/v1/cli/show platform software cpm switch {mode} B0 control-info

### Parameters
#### Path Parameters
- **mode** (string) - Required - The mode of the CPM switch (e.g., 'active', 'standby').

### Request Example
```json
{
  "cli_command": "show platform software cpm switch active B0 control-info"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed control information ..."
}
```
```

--------------------------------

### Show Platform Software BP Crimson Statistics

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software bp crimson statistics' command.

```APIDOC
## GET show platform software bp crimson statistics

### Description
Parses the 'show platform software bp crimson statistics' command to display statistics for the BP Crimson content.

### Method
GET

### Endpoint
/api/v1/cli/show platform software bp crimson statistics

### Request Example
```json
{
  "cli_command": "show platform software bp crimson statistics"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed Crimson content statistics ..."
}
```
```

--------------------------------

### Show Platform Software TDL Content BP Config Mode

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software tdl-database content bp config {mode}' command.

```APIDOC
## GET show platform software tdl-database content bp config {mode}

### Description
Parses the 'show platform software tdl-database content bp config {mode}' command to display the configuration of the TDL database content for BP.

### Method
GET

### Endpoint
/api/v1/cli/show platform software tdl-database content bp config {mode}

### Parameters
#### Path Parameters
- **mode** (string) - Required - The mode for which to display the configuration.

### Request Example
```json
{
  "cli_command": "show platform software tdl-database content bp config default"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed TDL content configuration ..."
}
```
```

--------------------------------

### Show Crypto IKEv2 SA Detail

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/february.rst

Parses the 'show crypto ikev2 sa detail' command to retrieve detailed information about IKEv2 security associations.

```APIDOC
## SHOW CRYPTO IKEV2 SA DETAIL

### Description
Parses the 'show crypto ikev2 sa detail' command.

### Method
GET

### Endpoint
/api/show/crypto/ikev2/sa/detail

### Parameters
#### Query Parameters
- **output** (string) - Optional - Specify output format (e.g., 'json').

### Request Example
```json
{
  "example": "/api/show/crypto/ikev2/sa/detail?output=json"
}
```

### Response
#### Success Response (200)
- **sa_details** (array) - List of detailed IKEv2 SA information.
  - **sa_id** (string) - SA identifier.
  - **remote_ip** (string) - Remote IP address.
  - **local_ip** (string) - Local IP address.
  - **status** (string) - Status of the SA.
  - **encryption** (string) - Encryption algorithm.
  - **integrity** (string) - Integrity algorithm.

#### Response Example
```json
{
  "example": {
    "sa_details": [
      {
        "sa_id": "1",
        "remote_ip": "10.1.1.1",
        "local_ip": "192.168.0.1",
        "status": "ESTABLISHED",
        "encryption": "AES-256",
        "integrity": "SHA256"
      }
    ]
  }
}
```
```

--------------------------------

### CRYPTO Commands

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2019/APRIL.md

Retrieve information about PKI certificates.

```APIDOC
## GET /network/ios/crypto/pki/certificates

### Description
Retrieves all available PKI certificates.

### Method
GET

### Endpoint
/network/ios/crypto/pki/certificates

### Parameters

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **certificates** (array) - A list of certificate objects.
  - **name** (string) - The name of the certificate.
  - **subject** (string) - The certificate subject.
  - **issuer** (string) - The certificate issuer.
  - **validity** (string) - The certificate validity period.

#### Response Example
```json
{
  "certificates": [
    {
      "name": "MyCert",
      "subject": "CN=example.com,O=MyOrg",
      "issuer": "CN=MyCA,O=MyCAOrg",
      "validity": "2023-01-01 to 2024-01-01"
    }
  ]
}
```

## GET /network/ios/crypto/pki/certificates/{word}

### Description
Retrieves PKI certificates matching a specific word or identifier.

### Method
GET

### Endpoint
/network/ios/crypto/pki/certificates/{word}

### Parameters
#### Path Parameters
- **word** (string) - Required - A keyword to filter certificates.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **certificates** (array) - A list of certificate objects matching the criteria.
  - **name** (string) - The name of the certificate.
  - **subject** (string) - The certificate subject.

#### Response Example
```json
{
  "certificates": [
    {
      "name": "SpecificCert",
      "subject": "CN=specific.example.com"
    }
  ]
}
```
```

--------------------------------

### Show Crypto Session Local Detail

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/february.rst

Parses the 'show crypto session local {ip_address} detail' command to retrieve detailed information about local crypto sessions.

```APIDOC
## SHOW CRYPTO SESSION LOCAL DETAIL

### Description
Parses the 'show crypto session local {ip_address} detail' command.

### Method
GET

### Endpoint
/api/show/crypto/session/local/{ip_address}/detail

### Parameters
#### Path Parameters
- **ip_address** (string) - Required - The local IP address of the crypto session.

#### Query Parameters
- **output** (string) - Optional - Specify output format (e.g., 'json').

### Request Example
```json
{
  "example": "/api/show/crypto/session/local/192.168.1.1/detail?output=json"
}
```

### Response
#### Success Response (200)
- **session_info** (object) - Detailed information about the local crypto session.
  - **ip_address** (string) - The IP address of the session.
  - **protocol** (string) - The protocol used (e.g., 'IPsec').
  - **state** (string) - The state of the session (e.g., 'ACTIVE').
  - **encryption** (string) - Encryption algorithm.
  - **hash** (string) - Hash algorithm.

#### Response Example
```json
{
  "example": {
    "session_info": {
      "ip_address": "192.168.1.1",
      "protocol": "IPsec",
      "state": "ACTIVE",
      "encryption": "AES-256",
      "hash": "SHA256"
    }
  }
}
```
```

--------------------------------

### IOS-XR Show Commands

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/august.rst

Parsers for 'show' commands specific to IOS-XR devices.

```APIDOC
## ShowRcmdNode

### Description
Parses the output of the 'show rcmd node' command on IOS-XR devices.

### Method
GET

### Endpoint
/iosxr/show/rcmd/node

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **rcmd_nodes** (array) - A list of RCMD node information.

#### Response Example
```json
{
  "rcmd_nodes": [
    {
      "node_name": "RP0",
      "role": "Primary",
      "status": "Active"
    }
  ]
}
```

## ShowRcmdMemory

### Description
Parses the output of the 'show rcmd memory' command on IOS-XR devices.

### Method
GET

### Endpoint
/iosxr/show/rcmd/memory

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **rcmd_memory_usage** (object) - Memory usage details for RCMD.

#### Response Example
```json
{
  "rcmd_memory_usage": {
    "total_memory": "1024MB",
    "used_memory": "512MB",
    "free_memory": "512MB"
  }
}
```
```

--------------------------------

### SROS Show Commands

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/august.rst

Parsers for 'show' commands specific to SROS devices.

```APIDOC
## ShowServiceSdpUsing

### Description
Parses the output of the 'show service sdp-using' command on SROS devices.

### Method
GET

### Endpoint
/sros/show/service/sdp-using

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **sdp_usage** (array) - A list of SDP usage details.

#### Response Example
```json
{
  "sdp_usage": [
    {
      "sdp_id": "10.1",
      "service_id": "100",
      "state": "Up"
    }
  ]
}
```
```

--------------------------------

### Show Platform Software Fed Active IFM Mappings

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/february.rst

Parses the 'show platform software fed active ifm mappings' command to retrieve information about forwarding information management mappings.

```APIDOC
## SHOW PLATFORM SOFTWARE FED ACTIVE IFM MAPPINGS

### Description
Parses the 'show platform software fed active ifm mappings' command.

### Method
GET

### Endpoint
/api/show/platform/software/fed/active/ifm/mappings

### Parameters
#### Query Parameters
- **output** (string) - Optional - Specify output format (e.g., 'json').

### Request Example
```json
{
  "example": "/api/show/platform/software/fed/active/ifm/mappings?output=json"
}
```

### Response
#### Success Response (200)
- **mappings** (array) - List of IFM mappings.
  - **id** (string) - Mapping identifier.
  - **state** (string) - Current state of the mapping.
  - **protocol** (string) - Associated protocol.

#### Response Example
```json
{
  "example": {
    "mappings": [
      {
        "id": "123",
        "state": "active",
        "protocol": "BGP"
      }
    ]
  }
}
```
```

--------------------------------

### Show Platform Software Node Cluster Manager Switch Mode B0 Node

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software node cluster-manager switch {mode} B0 node {node}' command.

```APIDOC
## GET show platform software node cluster-manager switch {mode} B0 node {node}

### Description
Parses the 'show platform software node cluster-manager switch {mode} B0 node {node}' command to retrieve information about a specific node within the cluster manager.

### Method
GET

### Endpoint
/api/v1/cli/show platform software node cluster-manager switch {mode} B0 node {node}

### Parameters
#### Path Parameters
- **mode** (string) - Required - The switch mode (e.g., 'active', 'standby').
- **node** (string) - Required - The node identifier.

### Request Example
```json
{
  "cli_command": "show platform software node cluster-manager switch active B0 node 1"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed node information ..."
}
```
```

--------------------------------

### Show Platform Software TDL Content BP Oper Mode

Source: https://github.com/suhaibqr/salrabee-genie/blob/main/changelog/2022/january.rst

Parses the 'show platform software tdl-database content bp oper {mode}' command.

```APIDOC
## GET show platform software tdl-database content bp oper {mode}

### Description
Parses the 'show platform software tdl-database content bp oper {mode}' command to display the operational status of the TDL database content for BP.

### Method
GET

### Endpoint
/api/v1/cli/show platform software tdl-database content bp oper {mode}

### Parameters
#### Path Parameters
- **mode** (string) - Required - The mode for which to display the operational status.

### Request Example
```json
{
  "cli_command": "show platform software tdl-database content bp oper default"
}
```

### Response
#### Success Response (200)
- **output** (string) - The parsed output of the command.

#### Response Example
```json
{
  "output": "... parsed TDL content operational status ..."
}
```
```
Tokens:
Raw